]> git.notmuchmail.org Git - notmuch/blobdiff - vim/plugin/notmuch.vim
vim: cleanup settings in newBuffer() and make them local
[notmuch] / vim / plugin / notmuch.vim
index a57b2ae8a1a9b16db3663e49dd36c8fde5db1f04..8e3a92abcfd82e9bef2310fc8552a5603aede88a 100644 (file)
 "
 " Authors: Bart Trojanowski <bart@jukie.net>
 
-" --- defaults
+" --- configuration defaults {{{1
 
-if !exists('g:notmuch_cmd')
-        let g:notmuch_cmd = 'notmuch'
-endif
+let s:notmuch_defaults = {
+        \ 'g:notmuch_cmd':                           'notmuch'                    ,
+        \ 'g:notmuch_debug':                         0                            ,
+        \
+        \ 'g:notmuch_search_newest_first':           1                            ,
+        \ 'g:notmuch_search_from_column_width':      20                           ,
+        \
+        \ 'g:notmuch_show_fold_signatures':          1                            ,
+        \ 'g:notmuch_show_fold_citations':           1                            ,
+        \ 'g:notmuch_show_fold_bodies':              0                            ,
+        \ 'g:notmuch_show_fold_headers':             1                            ,
+        \
+        \ 'g:notmuch_show_message_begin_regexp':     '^\fmessage{'                ,
+        \ 'g:notmuch_show_message_end_regexp':       '^\fmessage}'                ,
+        \ 'g:notmuch_show_header_begin_regexp':      '^\fheader{'                 ,
+        \ 'g:notmuch_show_header_end_regexp':        '^\fheader}'                 ,
+        \ 'g:notmuch_show_body_begin_regexp':        '^\fbody{'                   ,
+        \ 'g:notmuch_show_body_end_regexp':          '^\fbody}'                   ,
+        \ 'g:notmuch_show_attachment_begin_regexp':  '^\fattachment{'             ,
+        \ 'g:notmuch_show_attachment_end_regexp':    '^\fattachment}'             ,
+        \ 'g:notmuch_show_part_begin_regexp':        '^\fpart{'                   ,
+        \ 'g:notmuch_show_part_end_regexp':          '^\fpart}'                   ,
+        \ 'g:notmuch_show_marker_regexp':            '^\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$',
+        \
+        \ 'g:notmuch_show_message_parse_regexp':     '\(id:[^ ]*\) depth:\([0-9]*\) match:\([0-9]*\) filename:\(.*\)$',
+        \ 'g:notmuch_show_tags_regexp':              '(\([^)]*\))$'               ,
+        \
+        \ 'g:notmuch_show_signature_regexp':         '^\(-- \?\|_\+\)$'           ,
+        \ 'g:notmuch_show_signature_lines_max':      12                           ,
+        \
+        \ 'g:notmuch_show_citation_regexp':          '^\s*>'                      ,
+        \ }
 
-if !exists('g:notmuch_search_reverse')
-        let g:notmuch_search_reverse = 1
-endif
+" defaults for g:notmuch_initial_search_words
+" override with: let g:notmuch_initial_search_words = [ ... ]
+let s:notmuch_initial_search_words_defaults = [
+        \ 'tag:inbox and tag:unread',
+        \ ]
+
+" defaults for g:notmuch_show_headers
+" override with: let g:notmuch_show_headers = [ ... ]
+let s:notmuch_show_headers_defaults = [
+        \ 'Subject',
+        \ 'To',
+        \ 'Cc',
+        \ 'Bcc',
+        \ 'Date',
+        \ ]
+
+" defaults for g:notmuch_folders
+" override with: let g:notmuch_folders = [ ... ]
+let s:notmuch_folders_defaults = [
+        \ [ 'new',    'tag:inbox and tag:unread' ],
+        \ [ 'inbox',  'tag:inbox'                ],
+        \ [ 'unread', 'tag:unread'               ],
+        \ ]
+
+" --- keyboard mapping definitions {{{1
 
-" --- used to match output of notmuch
+" --- --- bindings for folders mode {{{2
 
-let s:notmuch_show_message_begin_regexp    = '^\fmessage{'
-let s:notmuch_show_message_end_regexp      = '^\fmessage}'
-let s:notmuch_show_header_begin_regexp     = '^\fheader{'
-let s:notmuch_show_header_end_regexp       = '^\fheader}'
-let s:notmuch_show_body_begin_regexp       = '^\fbody{'
-let s:notmuch_show_body_end_regexp         = '^\fbody}'
-let s:notmuch_show_attachment_begin_regexp = '^\fattachment{'
-let s:notmuch_show_attachment_end_regexp   = '^\fattachment}'
-let s:notmuch_show_part_begin_regexp       = '^\fpart{'
-let s:notmuch_show_part_end_regexp         = '^\fpart}'
-let s:notmuch_show_marker_regexp           = '^\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$'
+let g:notmuch_folders_maps = {
+        \ 's':          ':call <SID>NM_search_prompt()<CR>',
+        \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
+        \ '=':          ':call <SID>NM_folders_refresh_view()<CR>',
+        \ '<Enter>':    ':call <SID>NM_folders_show_search()<CR>',
+        \ }
 
-let s:notmuch_show_id_regexp               = '\(id:[^ ]*\)'
-let s:notmuch_show_depth_regexp            = ' depth:\([0-9]*\) '
-let s:notmuch_show_filename_regexp         = 'filename:\(.*\)$'
-let s:notmuch_show_tags_regexp             = '(\([^)]*\))$'
+" --- --- bindings for search screen {{{2
+let g:notmuch_search_maps = {
+        \ '<Enter>':    ':call <SID>NM_search_show_thread()<CR>',
+        \ '<C-]>':      ':call <SID>NM_search_expand(''<cword>'')<CR>',
+        \ 'a':          ':call <SID>NM_search_archive_thread()<CR>',
+        \ 'f':          ':call <SID>NM_search_filter()<CR>',
+        \ 'm':          ':call <SID>NM_new_mail()<CR>',
+        \ 'o':          ':call <SID>NM_search_toggle_order()<CR>',
+        \ 'r':          ':call <SID>NM_search_reply_to_thread()<CR>',
+        \ 's':          ':call <SID>NM_search_prompt()<CR>',
+        \ ',s':         ':call <SID>NM_search_edit()<CR>',
+        \ 't':          ':call <SID>NM_search_filter_by_tag()<CR>',
+        \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
+        \ '+':          ':call <SID>NM_search_add_tags([])<CR>',
+        \ '-':          ':call <SID>NM_search_remove_tags([])<CR>',
+        \ '=':          ':call <SID>NM_search_refresh_view()<CR>',
+        \ '?':          ':echo <SID>NM_search_thread_id()<CR>',
+        \ }
 
-let s:notmuch_show_signature_regexp        = '^\(-- \?\|_\+\)$'
-let s:notmuch_show_signature_lines_max     = 12
+" --- --- bindings for show screen {{{2
+let g:notmuch_show_maps = {
+        \ '<C-P>':      ':call <SID>NM_show_previous(1, 0)<CR>',
+        \ '<C-N>':      ':call <SID>NM_show_next(1, 0)<CR>',
+        \ '<C-]>':      ':call <SID>NM_search_expand(''<cword>'')<CR>',
+        \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
+        \
+        \ 'b':          ':call <SID>NM_show_fold_toggle(''b'', ''bdy'', !g:notmuch_show_fold_bodies)<CR>',
+        \ 'c':          ':call <SID>NM_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)<CR>',
+        \ 'h':          ':call <SID>NM_show_fold_toggle(''h'', ''hdr'', !g:notmuch_show_fold_headers)<CR>',
+        \ 's':          ':call <SID>NM_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)<CR>',
+        \
+        \ 'a':          ':call <SID>NM_show_archive_thread()<CR>',
+        \ 'A':          ':call <SID>NM_show_mark_read_then_archive_thread()<CR>',
+        \ 'N':          ':call <SID>NM_show_mark_read_then_next_open_message()<CR>',
+        \ 'v':          ':call <SID>NM_show_view_all_mime_parts()<CR>',
+        \ '+':          ':call <SID>NM_show_add_tag()<CR>',
+        \ '-':          ':call <SID>NM_show_remove_tag()<CR>',
+        \ '<Space>':    ':call <SID>NM_show_advance_marking_read_and_archiving()<CR>',
+        \ '\|':         ':call <SID>NM_show_pipe_message()<CR>',
+        \
+        \ '<S-Tab>':    ':call <SID>NM_show_previous_fold()<CR>',
+        \ '<Tab>':      ':call <SID>NM_show_next_fold()<CR>',
+        \ '<Enter>':    ':call <SID>NM_show_toggle_fold()<CR>',
+        \
+        \ 'r':          ':call <SID>NM_show_reply()<CR>',
+        \ 'm':          ':call <SID>NM_new_mail()<CR>',
+        \ '?':          ':echo <SID>NM_show_message_id() . ''  @ '' . join(<SID>NM_show_search_words())<CR>',
+        \ }
+
+
+" --- implement folders screen {{{1
+
+function! s:NM_cmd_folders(words)
+        if len(a:words)
+                echoe 'Not exapecting any arguments for folders command.'
+        endif
+        let cmd = ['count']
+        let disp = []
+        let searches = []
+        for entry in g:notmuch_folders
+                let [ name, search ] = entry
+                let data = s:NM_run(cmd + [search])
+                let cnt = matchlist(data, '\(\d\+\)')[1]
+                call add(disp, printf('%9d %-20s (%s)', cnt, name, search))
+                call add(searches, search)
+        endfor
 
-" --- implement search screen
+        call <SID>NM_newBuffer('folders', join(disp, "\n"))
+        let b:nm_searches = searches
+        let b:nm_timestamp = reltime()
+
+        call <SID>NM_cmd_folders_mksyntax()
+        call <SID>NM_set_map('n', g:notmuch_folders_maps)
+        setlocal cursorline
+        setlocal nowrap
+endfunction
+
+function! s:NM_cmd_folders_mksyntax()
+endfunction
+
+" --- --- folders screen action functions {{{2
+
+function! s:NM_folders_refresh_view()
+        let lno = line('.')
+        setlocal bufhidden=delete
+        call s:NM_cmd_folders([])
+        exec printf('norm %dG', lno)
+endfunction
+
+function! s:NM_folders_show_search()
+        let line = line('.')
+        let search = b:nm_searches[line-1]
+
+        let prev_bufnr = bufnr('%')
+        setlocal bufhidden=hide
+        call <SID>NM_cmd_search([search])
+        setlocal bufhidden=delete
+        let b:nm_prev_bufnr = prev_bufnr
+endfunction
+
+
+" --- implement search screen {{{1
 
 function! s:NM_cmd_search(words)
         let cmd = ['search']
-        if g:notmuch_search_reverse
-                let cmd = cmd + ['--reverse']
+        if g:notmuch_search_newest_first
+                let cmd = cmd + ['--sort=newest-first']
+        else
+                let cmd = cmd + ['--sort=oldest-first']
         endif
         let data = s:NM_run(cmd + a:words)
-        "let data = substitute(data, '27/27', '25/27', '')
-        "let data = substitute(data, '\[4/4\]', '[0/4]', '')
         let lines = split(data, "\n")
         let disp = copy(lines)
-        call map(disp, 'substitute(v:val, "^thread:\\S* ", "", "")' )
+        call map(disp, 's:NM_cmd_search_fmtline(v:val)')
 
-        call s:NM_newBuffer('search', join(disp, "\n"))
-        let b:nm_raw_data = lines
+        call <SID>NM_newBuffer('search', join(disp, "\n"))
+        let b:nm_raw_lines = lines
+        let b:nm_search_words = a:words
 
-        nnoremap <buffer> <Enter> :call <SID>NM_search_display()<CR>
-        nnoremap <buffer> s       :call <SID>NM_cmd_search(split(input('NotMuch Search:')))<CR>
+        call <SID>NM_cmd_search_mksyntax()
+        call <SID>NM_set_map('n', g:notmuch_search_maps)
         setlocal cursorline
         setlocal nowrap
 endfunction
+function! s:NM_cmd_search_fmtline(line)
+        let m = matchlist(a:line, '^\(thread:\S\+\)\s\([^]]\+\]\) \([^;]\+\); \(.*\) (\([^(]*\))$')
+        if !len(m)
+                return 'ERROR PARSING: ' . a:line
+        endif
+        let max = g:notmuch_search_from_column_width
+        let from = m[3]
+        if strlen(from) >= max
+                let from = substitute(m[3][0:max-4], '[^A-Za-z1-9_]*$', '', '') . '...'
+        endif
+        return printf('%-20s %-20s | %s (%s)', m[2], from, m[4], m[5])
+endfunction
+function! s:NM_cmd_search_mksyntax()
+        syntax clear nmSearchFrom
+        exec printf('syntax match nmSearchFrom /\(\] \)\@<=.\{%d\}/ oneline contained', g:notmuch_search_from_column_width)
+endfunction
+
+" --- --- search screen action functions {{{2
 
-function! s:NM_search_display()
-        if !exists('b:nm_raw_data')
-                echo 'no b:nm_raw_data'
+function! s:NM_search_show_thread()
+        let id = <SID>NM_search_thread_id()
+        if id != ''
+                let words = [id]
+                if exists('b:nm_search_words')
+                        let words = ['('] + b:nm_search_words + [')', 'and', id]
+                endif
+                if len(words)
+                        call <SID>NM_cmd_show(words)
+                endif
+        endif
+endfunction
+
+function! s:NM_search_prompt()
+        " TODO: input() can support completion
+        let text = input('NotMuch Search: ')
+        if strlen(text)
+                let tags = split(text)
+        else
+                let tags = s:notmuch_initial_search_words_defaults
+        endif
+        let prev_bufnr = bufnr('%')
+        if b:nm_type == 'search' && exists('b:nm_prev_bufnr')
+                " TODO: we intend to replace the current buffer,
+                "       ... maybe we could just clear it
+                let prev_bufnr = b:nm_prev_bufnr
+                setlocal bufhidden=delete
         else
-                let line = line('.')
-                let info = b:nm_raw_data[line-1]
-                let what = split(info, '\s\+')[0]
-                call s:NM_cmd_show([what])
+                setlocal bufhidden=hide
+        endif
+        call <SID>NM_cmd_search(tags)
+        setlocal bufhidden=delete
+        let b:nm_prev_bufnr = prev_bufnr
+endfunction
+
+function! s:NM_search_edit()
+        " TODO: input() can support completion
+        let text = input('NotMuch Search: ', join(b:nm_search_words, ' '))
+        if strlen(text)
+                call <SID>NM_cmd_search(split(text))
+        endif
+endfunction
+
+function! s:NM_search_archive_thread()
+        call <SID>NM_add_remove_tags_on_screen('', '-', ['inbox'])
+        call <SID>NM_add_remove_tags([], '-', ['inbox'])
+        norm j
+endfunction
+
+function! s:NM_search_filter()
+        call <SID>NM_search_filter_helper('Filter: ', '', '')
+endfunction
+
+function! s:NM_search_filter_by_tag()
+        call <SID>NM_search_filter_helper('Filter Tag(s): ', 'tag:', 'and')
+endfunction
+
+function! s:NM_search_filter_helper(prompt, prefix, joiner)
+        " TODO: input() can support completion
+        let text = input(a:prompt)
+        if !strlen(text)
+                return
+        endif
+
+        let tags = split(text)
+        if strlen(a:prefix)
+                call map(tags, 'a:prefix . v:val')
+        endif
+        if strlen(a:joiner)
+                let idx = len(tags) - 1
+                while idx > 0
+                        call insert(tags, a:joiner, idx)
+                        let idx = idx - 1
+                endwhile
+        endif
+        let tags = b:nm_search_words + ['and', '('] + tags + [')']
+
+        let prev_bufnr = bufnr('%')
+        setlocal bufhidden=hide
+        call <SID>NM_cmd_search(tags)
+        setlocal bufhidden=delete
+        let b:nm_prev_bufnr = prev_bufnr
+endfunction
+
+function! s:NM_search_toggle_order()
+        let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
+        " FIXME: maybe this would be better done w/o reading re-reading the lines
+        "         reversing the b:nm_raw_lines and the buffer lines would be better
+        call <SID>NM_search_refresh_view()
+endfunction
+
+function! s:NM_search_reply_to_thread()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_search_add_tags(tags)
+        call <SID>NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags)
+endfunction
+
+function! s:NM_search_remove_tags(tags)
+        call <SID>NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags)
+endfunction
+
+function! s:NM_search_refresh_view()
+        let lno = line('.')
+        let prev_bufnr = b:nm_prev_bufnr
+        setlocal bufhidden=delete
+        call <SID>NM_cmd_search(b:nm_search_words)
+        let b:nm_prev_bufnr = prev_bufnr
+        " FIXME: should find the line of the thread we were on if possible
+        exec printf('norm %dG', lno)
+endfunction
+
+" --- --- search screen helper functions {{{2
+
+function! s:NM_search_thread_id()
+        if !exists('b:nm_raw_lines')
+                echoe 'no b:nm_raw_lines'
+                return ''
         endif
+        let mnum = line('.') - 1
+        if len(b:nm_raw_lines) <= mnum
+                return ''
+        endif
+        echo 'len=' . string(len(b:nm_raw_lines)) . '  mnum=' . string(mnum)
+        let info = b:nm_raw_lines[mnum]
+        let what = split(info, '\s\+')[0]
+        return what
 endfunction
 
+function! s:NM_search_add_remove_tags(prompt, prefix, intags)
+        if type(a:intags) != type([]) || len(a:intags) == 0
+                " TODO: input() can support completion
+                let text = input(a:prompt)
+                if !strlen(text)
+                        return
+                endif
+                let tags = split(text, ' ')
+        else
+                let tags = a:intags
+        endif
+        call <SID>NM_add_remove_tags([], a:prefix, tags)
+        call <SID>NM_add_remove_tags_on_screen('', a:prefix, tags)
+endfunction
 
-" --- implement show screen
+" --- implement show screen {{{1
 
 function! s:NM_cmd_show(words)
-        let bufnr = bufnr('%')
+        let prev_bufnr = bufnr('%')
         let data = s:NM_run(['show'] + a:words)
+        let lines = split(data, "\n")
 
-        call s:NM_newBuffer('show', data)
+        let info = s:NM_cmd_show_parse(lines)
+
+        setlocal bufhidden=hide
+        call <SID>NM_newBuffer('show', join(info['disp'], "\n"))
         setlocal bufhidden=delete
-        let b:nm_raw_data = data
+        let b:nm_words = a:words
+        let b:nm_raw_info = info
+        let b:nm_prev_bufnr = prev_bufnr
 
-        call s:NM_cmd_show_mkfolds()
+        call <SID>NM_cmd_show_mkfolds()
+        call <SID>NM_cmd_show_mksyntax()
+        call <SID>NM_set_map('n', g:notmuch_show_maps)
+        setlocal foldtext=NM_cmd_show_foldtext()
+        setlocal fillchars=
+        setlocal foldcolumn=6
 
-        exec printf("nnoremap <buffer> q :b %d<CR>", bufnr)
 endfunction
 
-function! s:NM_cmd_show_mkfolds()
-        let modetype = ''
-        let modeline = -1
-        let lnum = 1
-        while lnum <= line('$')
-                let line = getline(lnum)
-                if modetype == ''
-                        if match(line, s:notmuch_show_signature_regexp) != -1
-                                let modetype = 'sig'
-                                let modeline = lnum
-                                echo "start=" . modeline
+function! s:NM_show_previous(can_change_thread, find_matching)
+        let info = b:nm_raw_info
+        let lnum = line('.')
+        for msg in reverse(copy(info['msgs']))
+                if a:find_matching && msg['match'] == '0'
+                        continue
+                endif
+                if lnum <= msg['start']
+                        continue
+                endif
+
+                exec printf('norm %dGzt', msg['start'])
+                " TODO: try to fit the message on screen
+                return
+        endfor
+        if !a:can_change_thread
+                return
+        endif
+        call <SID>NM_kill_this_buffer()
+        if line('.') > 1
+                norm k
+                call <SID>NM_search_show_thread()
+                norm G
+                call <SID>NM_show_previous(0, a:find_matching)
+        else
+                echo 'No more messages.'
+        endif
+endfunction
+
+function! s:NM_show_next(can_change_thread, find_matching)
+        let info = b:nm_raw_info
+        let lnum = line('.')
+        for msg in info['msgs']
+                if a:find_matching && msg['match'] == '0'
+                        continue
+                endif
+                if lnum >= msg['start']
+                        continue
+                endif
+
+                exec printf('norm %dGzt', msg['start'])
+                " TODO: try to fit the message on screen
+                return
+        endfor
+        if a:can_change_thread
+                call <SID>NM_show_next_thread()
+        endif
+endfunction
+
+function! s:NM_show_next_thread()
+        call <SID>NM_kill_this_buffer()
+        if line('.') != line('$')
+                norm j
+                call <SID>NM_search_show_thread()
+        else
+                echo 'No more messages.'
+        endif
+endfunction
+
+function! s:NM_show_archive_thread()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_mark_read_then_archive_thread()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_mark_read_then_next_open_message()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_previous_message()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_reply()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_view_all_mime_parts()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_view_raw_message()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_add_tag()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_remove_tag()
+        echo 'not implemented'
+endfunction
+
+" if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
+" otherwise go to next message
+" any message that is viewed entirely has inbox and unread tags removed
+function! s:NM_show_advance_marking_read_and_archiving()
+        let advance_tags = ['unread', 'inbox']
+
+        let vis_top = line('w0')
+        let vis_bot = line('w$')
+
+        let msg_top = <SID>NM_show_get_message_for_line(vis_top)
+        if !has_key(msg_top,'id')
+                echo "No top visible message."
+        endif
+
+        " if the top message is the last message, just expunge the entire thread and move on
+        if msg_top['end'] == line('$')
+                let ids = []
+                for msg in b:nm_raw_info['msgs']
+                        if has_key(msg,'match') && msg['match'] != '0'
+                                if len(ids)
+                                        call add(ids, 'OR')
+                                endif
+                                call add(ids, msg['id'])
                         endif
-                elseif modetype == 'sig'
-                        if (lnum - modeline) > s:notmuch_show_signature_lines_max
-                                let modetype = ''
-                        elseif match(line, s:notmuch_show_part_end_regexp) != -1
-                                exec printf('%d,%dfold', modeline, lnum)
-                                let modetype = ''
+                endfor
+
+                let filter = ['('] + advance_tags + [')', 'AND', '('] + ids + [')']
+                call <SID>NM_add_remove_tags(filter, '-', advance_tags)
+                call <SID>NM_show_next(1, 1)
+                return
+        endif
+
+        let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
+        if !has_key(msg_bot,'id')
+                echo "No bottom visible message."
+        endif
+
+        " if entire message fits on the screen, read/archive it, move to the next one
+        if msg_top['id'] != msg_bot['id'] || msg_top['end'] <= vis_bot
+                call <SID>NM_add_remove_tags_on_screen(msg_top['start'], '-', advance_tags)
+                exec printf('norm %dG', vis_top)
+                call <SID>NM_show_next(0, 1)
+                if has_key(msg_top,'match') && msg_top['match'] != '0'
+                        redraw
+                        " do this last to hide the latency
+                        let filter = ['('] + advance_tags + [')', 'AND', msg_top['id']]
+                        call <SID>NM_add_remove_tags(filter, '-', advance_tags)
+                endif
+                return
+        endif
+
+        " entire message does not fit on the screen, scroll down to bottom, max 1/2 screen
+        let jmp = winheight(winnr()) / 2
+        let max = msg_bot['end'] - vis_bot
+        if jmp > max
+                let jmp = max
+        endif
+        exec printf('norm %dGzt', vis_top + jmp)
+        return
+endfunction
+
+function! s:NM_show_pipe_message()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_previous_fold()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_next_fold()
+        echo 'not implemented'
+endfunction
+
+function! s:NM_show_toggle_fold()
+        echo 'not implemented'
+endfunction
+
+
+" --- --- show screen helper functions {{{2
+
+function! s:NM_show_get_message_for_line(line)
+        for msg in b:nm_raw_info['msgs']
+                if a:line > msg['end']
+                        continue
+                endif
+                return msg
+        endfor
+        return {}
+endfunction
+
+function! s:NM_show_message_id()
+        if !exists('b:nm_raw_info')
+                echoe 'no b:nm_raw_info'
+                return ''
+        endif
+        let msg = <SID>NM_show_get_message_for_line(line('.'))
+        if has_key(msg,'id')
+                return msg['id']
+        endif
+        return ''
+endfunction
+
+function! s:NM_show_search_words()
+        if !exists('b:nm_words')
+                echoe 'no b:nm_words'
+                return []
+        endif
+        return b:nm_words
+endfunction
+
+function! s:NM_show_fold_toggle(key, type, fold)
+        let info = b:nm_raw_info
+        let act = 'open'
+        if a:fold
+                let act = 'close'
+        endif
+        for fld in info['folds']
+                if fld[0] == a:type
+                        exec printf('%dfold%s', fld[1], act)
+                endif
+        endfor
+        exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
+endfunction
+
+
+" s:NM_cmd_show_parse returns the following dictionary:
+"    'disp':     lines to display
+"    'msgs':     message info dicts { start, end, id, depth, filename, descr, header }
+"    'folds':    fold info arrays [ type, start, end ]
+"    'foldtext': fold text indexed by start line
+function! s:NM_cmd_show_parse(inlines)
+        let info = { 'disp': [],       
+                   \ 'msgs': [],       
+                   \ 'folds': [],      
+                   \ 'foldtext': {} }  
+        let msg = {}
+        let hdr = {}
+
+        let in_message = 0
+        let in_header = 0
+        let in_body = 0
+        let in_part = ''
+
+        let body_start = -1
+        let part_start = -1
+
+        let mode_type = ''
+        let mode_start = -1
+
+        let inlnum = 0
+        for line in a:inlines
+                let inlnum = inlnum + 1
+                let foldinfo = []
+
+                if strlen(in_part)
+                        let part_end = 0
+
+                        if match(line, g:notmuch_show_part_end_regexp) != -1
+                                let part_end = len(info['disp'])
+                        else
+                                call add(info['disp'], line)
+                        endif
+
+                        if in_part == 'text/plain'
+                                if !part_end && mode_type == ''
+                                        if match(line, g:notmuch_show_signature_regexp) != -1
+                                                let mode_type = 'sig'
+                                                let mode_start = len(info['disp'])
+                                        elseif match(line, g:notmuch_show_citation_regexp) != -1
+                                                let mode_type = 'cit'
+                                                let mode_start = len(info['disp'])
+                                        endif
+                                elseif mode_type == 'cit'
+                                        if part_end || match(line, g:notmuch_show_citation_regexp) == -1
+                                                let outlnum = len(info['disp'])
+                                                let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
+                                                               \ printf('[ %d-line citation.  Press "c" to show. ]', outlnum - mode_start) ]
+                                                let mode_type = ''
+                                        endif
+                                elseif mode_type == 'sig'
+                                        let outlnum = len(info['disp'])
+                                        if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
+                                                let mode_type = ''
+                                        elseif part_end
+                                                let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
+                                                               \ printf('[ %d-line signature.  Press "s" to show. ]', outlnum - mode_start) ]
+                                                let mode_type = ''
+                                        endif
+                                endif
+                        endif
+
+                        if part_end
+                                " FIXME: this is a hack for handling two folds being added for one line
+                                "         we should handle addinga fold in a function
+                                if len(foldinfo) && foldinfo[1] < foldinfo[2]
+                                        call add(info['folds'], foldinfo[0:3])
+                                        let info['foldtext'][foldinfo[1]] = foldinfo[4]
+                                endif
+
+                                let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
+                                               \ printf('[ %d-line %s.  Press "p" to show. ]', part_end - part_start, in_part) ]
+                                let in_part = ''
+                                call add(info['disp'], '')
+                        endif
+
+                elseif in_body
+                        if !has_key(msg,'body_start')
+                                let msg['body_start'] = len(info['disp']) + 1
+                        endif
+                        if match(line, g:notmuch_show_body_end_regexp) != -1
+                                let body_end = len(info['disp'])
+                                let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
+                                               \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
+
+                                let in_body = 0
+
+                        elseif match(line, g:notmuch_show_part_begin_regexp) != -1
+                                let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
+                                let in_part = 'unknown'
+                                if len(m)
+                                        let in_part = m[2]
+                                endif
+                                call add(info['disp'],
+                                         \ printf('--- %s ---', in_part))
+                                let part_start = len(info['disp']) + 1
+                        endif
+
+                elseif in_header
+                        if in_header == 1
+                                let msg['descr'] = line
+                                call add(info['disp'], line)
+                                let in_header = 2
+                                let msg['hdr_start'] = len(info['disp']) + 1
+
+                        else
+                                if match(line, g:notmuch_show_header_end_regexp) != -1
+                                        let hdr_start = msg['hdr_start']+1
+                                        let hdr_end = len(info['disp'])
+                                        let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
+                                               \ printf('[ %d-line headers.  Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
+                                        let msg['header'] = hdr
+                                        let in_header = 0
+                                        let hdr = {}
+                                else
+                                        let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
+                                        if len(m)
+                                                let hdr[m[1]] = m[2]
+                                                if match(g:notmuch_show_headers, m[1]) != -1
+                                                        call add(info['disp'], line)
+                                                endif
+                                        endif
+                                endif
+                        endif
+
+                elseif in_message
+                        if match(line, g:notmuch_show_message_end_regexp) != -1
+                                let msg['end'] = len(info['disp'])
+                                call add(info['disp'], '')
+
+                                let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
+                                               \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
+
+                                call add(info['msgs'], msg)
+                                let msg = {}
+                                let in_message = 0
+                                let in_header = 0
+                                let in_body = 0
+                                let in_part = ''
+
+                        elseif match(line, g:notmuch_show_header_begin_regexp) != -1
+                                let in_header = 1
+                                continue
+
+                        elseif match(line, g:notmuch_show_body_begin_regexp) != -1
+                                let body_start = len(info['disp']) + 1
+                                let in_body = 1
+                                continue
+                        endif
+
+                else
+                        if match(line, g:notmuch_show_message_begin_regexp) != -1
+                                let msg['start'] = len(info['disp']) + 1
+
+                                let m = matchlist(line, g:notmuch_show_message_parse_regexp)
+                                if len(m)
+                                        let msg['id'] = m[1]
+                                        let msg['depth'] = m[2]
+                                        let msg['match'] = m[3]
+                                        let msg['filename'] = m[4]
+                                endif
+
+                                let in_message = 1
                         endif
                 endif
 
-                let lnum = lnum + 1
-        endwhile
+                if len(foldinfo) && foldinfo[1] < foldinfo[2]
+                        call add(info['folds'], foldinfo[0:3])
+                        let info['foldtext'][foldinfo[1]] = foldinfo[4]
+                endif
+        endfor
+        return info
+endfunction
+
+function! s:NM_cmd_show_mkfolds()
+        let info = b:nm_raw_info
+
+        for afold in info['folds']
+                exec printf('%d,%dfold', afold[1], afold[2])
+                let state = 'open'
+                if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
+                 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
+                 \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
+                 \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
+                        let state = 'close'
+                elseif afold[0] == 'msg'
+                        let idx = afold[3]
+                        let msg = info['msgs'][idx]
+                        if has_key(msg,'match') && msg['match'] == '0'
+                                let state = 'close'
+                        endif
+                endif
+                exec printf('%dfold%s', afold[1], state)
+        endfor
+endfunction
+
+function! s:NM_cmd_show_mksyntax()
+        let info = b:nm_raw_info
+        let cnt = 0
+        for msg in info['msgs']
+                let cnt = cnt + 1
+                let start = msg['start']
+                let hdr_start = msg['hdr_start']
+                let body_start = msg['body_start']
+                let end = msg['end']
+                exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
+                exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
+                exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
+        endfor
+endfunction
+
+function! NM_cmd_show_foldtext()
+        let foldtext = b:nm_raw_info['foldtext']
+        return foldtext[v:foldstart]
 endfunction
 
 
-" --- helper functions
+" --- notmuch helper functions {{{1
 
-function! s:NM_newBuffer(ft, content)
+function! s:NM_newBuffer(type, content)
         enew
-        setlocal buftype=nofile readonly modifiable
+        setlocal buftype=nofile readonly modifiable scrolloff=0 sidescrolloff=0
         silent put=a:content
         keepjumps 0d
         setlocal nomodifiable
-        execute printf('set filetype=notmuch-%s', a:ft)
-        execute printf('set syntax=notmuch-%s', a:ft)
+        execute printf('set filetype=notmuch-%s', a:type)
+        execute printf('set syntax=notmuch-%s', a:type)
+        let b:nm_type = a:type
+endfunction
+
+function! s:NM_shell_escape(word)
+        let word = substitute(a:word, '''', '\\''', 'g')
+        return '''' . word . ''''
+endfunction
+
+" this function was taken from git.vim, then fixed up
+" http://github.com/motemen/git-vim
+function! s:NM_shell_split(cmd)
+        let l:split_cmd = []
+        let cmd = a:cmd
+        let iStart = 0
+        while 1
+                let t = match(cmd, '\S', iStart)
+                if t < iStart
+                        break
+                endif
+                let iStart = t
+
+                let iSpace = match(cmd, '\v(\s|$)', iStart)
+                if iSpace < iStart
+                        break
+                endif
+
+                let iQuote1 = match(cmd, '\(^["'']\|[^\\]\@<=["'']\)', iStart)
+                if iQuote1 > iSpace || iQuote1 < iStart
+                        let iEnd = iSpace - 1
+                        let l:split_cmd += [ cmd[iStart : iEnd] ]
+                else
+                        let q = cmd[iQuote1]
+                        let iQuote2 = match(cmd, '[^\\]\@<=[' . q . ']', iQuote1 + 1)
+                        if iQuote2 < iQuote1
+                                throw 'No matching ' . q . ' quote'
+                        endif
+                        let iEnd = iQuote2
+                        let l:split_cmd += [ cmd[iStart+1 : iEnd-1 ] ]
+                endif
+
+
+                let iStart = iEnd + 1
+        endwhile
+
+        return l:split_cmd
 endfunction
 
+
 function! s:NM_run(args)
-        let cmd = g:notmuch_cmd . ' ' . join(a:args) . '< /dev/null'
+        let words = a:args
+        call map(words, 's:NM_shell_escape(v:val)')
+        let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
+
+        let start = reltime()
         let out = system(cmd)
-        if v:shell_error
+        let err = v:shell_error
+        let delta = reltime(start)
+
+        if exists('g:notmuch_debug') && g:notmuch_debug
+                echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
+        endif
+
+        if err
                 echohl Error
                 echo substitute(out, '\n*$', '', '')
                 echohl None
@@ -152,30 +925,142 @@ function! s:NM_run(args)
         endif
 endfunction
 
+" --- external mail handling helpers {{{1
+
+function! s:NM_new_mail()
+        echo 'not implemented'
+endfunction
+
+" --- other helpers {{{1
+
+function! s:NM_kill_this_buffer()
+        if exists('b:nm_prev_bufnr')
+                setlocal bufhidden=delete
+                exec printf(":buffer %d", b:nm_prev_bufnr)
+        else
+                echo "This is the last buffer; use :q<CR> to quit."
+        endif
+endfunction
+
+function! s:NM_search_expand(arg)
+        let word = expand(a:arg)
+        let prev_bufnr = bufnr('%')
+        setlocal bufhidden=hide
+        call <SID>NM_cmd_search([word])
+        setlocal bufhidden=delete
+        let b:nm_prev_bufnr = prev_bufnr
+endfunction
+
+function! s:NM_add_remove_tags(filter, prefix, tags)
+        let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
+        if !len(filter)
+                echoe 'Eeek! I couldn''t find the thead id!'
+        endif
+        call map(a:tags, 'a:prefix . v:val')
+        let args = ['tag']
+        call extend(args, a:tags)
+        call add(args, '--')
+        call extend(args, filter)
+        " TODO: handle errors
+        call <SID>NM_run(args)
+endfunction
+
+function! s:NM_add_remove_tags_on_screen(online, prefix, tags)
+        setlocal modifiable
+        if a:prefix == '-'
+                for tagname in a:tags
+                        exec printf('silent! %ss/(\([^)]*\)\<%s\>\([^)]*\))$/(\1\2)/', string(a:online), tagname)
+                endfor
+        else
+                for tagname in a:tags
+                        exec printf('silent! %ss/(\([^)]*\)\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
+                endfor
+        endif
+        setlocal nomodifiable
+endfunction
+
+" --- process and set the defaults {{{1
 
-" --- command handler
+function! NM_set_defaults(force)
+        for [key, dflt] in items(s:notmuch_defaults)
+                let cmd = ''
+                if !a:force && exists(key) && type(dflt) == type(eval(key))
+                        continue
+                elseif type(dflt) == type(0)
+                        let cmd = printf('let %s = %d', key, dflt)
+                elseif type(dflt) == type('')
+                        let cmd = printf('let %s = ''%s''', key, dflt)
+                " FIXME: not sure why this didn't work when dflt is an array
+                "elseif type(dflt) == type([])
+                "        let cmd = printf('let %s = %s', key, string(dflt))
+                else
+                        echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
+                                                \ a:force, key, string(dflt))
+                        continue
+                endif
+                exec cmd
+        endfor
+endfunction
+call NM_set_defaults(0)
+
+" for some reason NM_set_defaults() didn't work for arrays...
+if !exists('g:notmuch_show_headers')
+        let g:notmuch_show_headers = s:notmuch_show_headers_defaults
+endif
+if !exists('g:notmuch_initial_search_words')
+        let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
+endif
+if !exists('g:notmuch_folders')
+        let g:notmuch_folders = s:notmuch_folders_defaults
+endif
+
+
+" --- assign keymaps {{{1
+
+function! s:NM_set_map(type, maps)
+        nmapclear
+        for [key, code] in items(a:maps)
+                exec printf('%snoremap <buffer> %s %s', a:type, key, code)
+        endfor
+        " --- this is a hack for development :)
+        nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
+endfunction
+
+" --- command handler {{{1
 
 function! NotMuch(args)
-        if !strlen(a:args)
-                call s:NM_cmd_search(['tag:inbox'])
-                return
+        let args = a:args
+        if !strlen(args)
+                let args = 'folders'
         endif
 
-        echo "blarg!"
+        let words = <SID>NM_shell_split(args)
+        if words[0] == 'folders' || words[0] == 'f'
+                let words = words[1:]
+                call <SID>NM_cmd_folders(words)
 
-        let words = split(a:args)
-        " TODO: handle commands passed as arguments
+        elseif words[0] == 'search' || words[0] == 's'
+                if len(words) > 1
+                        let words = words[1:]
+                elseif exists('b:nm_search_words')
+                        let words = b:nm_search_words
+                else
+                        let words = g:notmuch_initial_search_words
+                endif
+                call <SID>NM_cmd_search(words)
+
+        elseif words[0] == 'show'
+                echoe 'show is not yet implemented.'
+        endif
 endfunction
 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
         return []
 endfunction
 
 
-" --- glue
+" --- glue {{{1
 
 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
 cabbrev  notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
 
-" --- hacks, only for development :)
-
-nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
+" vim: set ft=vim ts=8 sw=8 et foldmethod=marker :