Blob plugin/querycommandcomplete.vim
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
" Query Command Complete " ====================== " " Vim plugin to suggest completions with the results of an external " query command. " " The original intention is to use it as a mutt query_command wrapper " to complete addresses in the mail headers, but it can be adapted " to any other kind of functionality by modifying the exposed setting " parameters. " " Last Change: 2013 Jun 16 " Author: Caio Romão (http://caioromao.com) " License: This file is placed in the public domain " Contributors: " Brian Henderson https://github.com/bhenderson " Mark Stillwell https://github.com/marklee77 " " Setup: " This plugin exports the completion function QueryCommandComplete, " which can be set as the complete function (or omni function) for " any filetype. If you have a working mutt setup with query_command " configured, the plugin works out of the box. " " Example: " let g:qcc_query_command='abook' " au BufRead /tmp/mutt* setlocal omnifunc=QueryCommandComplete " " Settings: " g:qcc_query_command " External command that queries for contacts " If empty, QueryCommandComplete tries to guess what command to " run by executing `mutt -Q query_command`. " " g:qcc_line_separator " Separator for each entry in the result from the query " default: '\n' " " g:qcc_field_separator " Separator for the fields of an entry from the result " default: '\t' " " g:qcc_pattern " Pattern used to match against the current line to decide " whether to call the query command " default: '^\(To\|Cc\|Bcc\|From\|Reply-To\):' " " g:qcc_multiline " Whether to try matching g:qcc_pattern against the current " and any previous line " default: 0 " " g:qcc_multiline_pattern " Pattern to match against the current line when deciding " wether to keep looking for a line that matches g:qcc_pattern " This provides finer control over the recursion, which " is useful if calling the completion on really big files. " default: '.*' " " g:qcc_format_word " Format string to be used when building the word field " of the completion (i.e.: the final result, what gets fed into " the current line when you select an option) " default: '${0} <${1}>' (as in: FirstName <email@domain.com>) " " g:qcc_format_abbr " Format string to be used when building the abbreviation " for the completion menu (i.e.: the first row in the completion " menu). " default: '${0}' " " g:qcc_format_menu " Format string for the optional second column of the completion " menu. " default: '${2}' " if exists("g:loaded_QueryCommandComplete") || &cp finish endif " Try to use mutt's query_command by default if nothing is set if !exists("g:qcc_query_command") let s:querycmd = system('mutt -Q query_command 2>/dev/null') let s:querycmd = substitute(s:querycmd, '^query_command="\(.*\)"\n', '\1','') if len(s:querycmd) let g:qcc_query_command = s:querycmd let g:qcc_multiline = 1 autocmd FileType mail setlocal omnifunc=QueryCommandComplete else echoerr "QueryCommandComplete: g:qcc_query_command not set!" finish endif endif let g:loaded_QueryCommandComplete = 1 let s:save_cpo = &cpo set cpo&vim function! s:DefaultIfUnset(name, default) if !exists(a:name) let {a:name} = a:default endif endfunction call s:DefaultIfUnset('g:qcc_line_separator', '\n') call s:DefaultIfUnset('g:qcc_field_separator', '\t') call s:DefaultIfUnset('g:qcc_pattern', '^\(To\|Cc\|Bcc\|From\|Reply-To\):') call s:DefaultIfUnset('g:qcc_multiline', 0) call s:DefaultIfUnset('g:qcc_multiline_pattern', '.*') call s:DefaultIfUnset('g:qcc_format_word', '${0} <${1}>') call s:DefaultIfUnset('g:qcc_format_abbr', '${0}') call s:DefaultIfUnset('g:qcc_format_menu', '${2}') " Given a format string where the placeholders are in the format " '${index}' and index is a valid index the the given 'fields' " argument, this function returns a string with all placeholders " replaced by the corresponding data in the fields list. " FIXME I can't help but think there's a standard way to do this " but I failed finding it. Please call me a dumbass if you " know The Easy Way. function! s:ApplyFieldsToFormatString(fields, format) let result = a:format while 1 let placeholder = matchstr(result, '${[0-9]}') if (empty(placeholder)) break endif let index = matchstr(placeholder, '[0-9]') " If ${NUMBER} is not a valid index in a:fields, " use '' as a fallback. " FIXME Decide whether to warn/err/whatever here let content = '' if (len(a:fields) > index) let content = a:fields[index] endif let result = substitute(result, placeholder, content, 'g') endwhile return result endfunction function! s:MakeCompletionEntry(fields) let entry = {} let entry.word = s:ApplyFieldsToFormatString(a:fields, g:qcc_format_word) let entry.abbr = s:ApplyFieldsToFormatString(a:fields, g:qcc_format_abbr) let entry.menu = s:ApplyFieldsToFormatString(a:fields, g:qcc_format_menu) let entry.icase = 1 return entry endfunction function! s:FindStartingIndex() let cur_line = getline('.') " locate the start of the word let start = col('.') - 1 while start > 0 && cur_line[start - 1] =~ '[^:,]' let start -= 1 endwhile " lstrip() while cur_line[start] =~ '[ ]' let start += 1 endwhile return start endfunction function! s:GenerateCompletions(findstart, base) if a:findstart return s:FindStartingIndex() endif let results = [] let cmd = g:qcc_query_command if cmd !~ '%s' let cmd .= ' %s' endif let cmd = substitute(cmd, '%s', shellescape(a:base), '') let lines = split(system(cmd), g:qcc_line_separator) for my_line in lines let fields = split(my_line, g:qcc_field_separator) let entry = s:MakeCompletionEntry(fields) call add(results, entry) endfor return results endfunction function! s:ShouldGenerateCompletions(line_number) let current_line = getline(a:line_number) if current_line =~ g:qcc_pattern return 1 endif if ! g:qcc_multiline || a:line_number <= 1 || current_line !~ g:qcc_multiline_pattern return 0 endif return s:ShouldGenerateCompletions(a:line_number - 1) endfunction function! QueryCommandComplete(findstart, base) if s:ShouldGenerateCompletions(line('.')) return s:GenerateCompletions(a:findstart, a:base) endif endfunction let &cpo = s:save_cpo |