1" Functions shared by several tests. 2 3" Only load this script once. 4if exists('*WaitFor') 5 finish 6endif 7 8" Get the name of the Python executable. 9" Also keeps it in s:python. 10func PythonProg() 11 " This test requires the Python command to run the test server. 12 " This most likely only works on Unix and Windows. 13 if has('unix') 14 " We also need the job feature or the pkill command to make sure the server 15 " can be stopped. 16 if !(executable('python') && (has('job') || executable('pkill'))) 17 return '' 18 endif 19 let s:python = 'python' 20 elseif has('win32') 21 " Use Python Launcher for Windows (py.exe) if available. 22 if executable('py.exe') 23 let s:python = 'py.exe' 24 elseif executable('python.exe') 25 let s:python = 'python.exe' 26 else 27 return '' 28 endif 29 else 30 return '' 31 endif 32 return s:python 33endfunc 34 35" Run "cmd". Returns the job if using a job. 36func RunCommand(cmd) 37 let job = 0 38 if has('job') 39 let job = job_start(a:cmd, {"stoponexit": "hup"}) 40 call job_setoptions(job, {"stoponexit": "kill"}) 41 elseif has('win32') 42 exe 'silent !start cmd /c start "test_channel" ' . a:cmd 43 else 44 exe 'silent !' . a:cmd . '&' 45 endif 46 return job 47endfunc 48 49" Read the port number from the Xportnr file. 50func GetPort() 51 let l = [] 52 for i in range(200) 53 try 54 let l = readfile("Xportnr") 55 catch 56 endtry 57 if len(l) >= 1 58 break 59 endif 60 sleep 10m 61 endfor 62 call delete("Xportnr") 63 64 if len(l) == 0 65 " Can't make the connection, give up. 66 return 0 67 endif 68 return l[0] 69endfunc 70 71" Run a Python server for "cmd" and call "testfunc". 72" Always kills the server before returning. 73func RunServer(cmd, testfunc, args) 74 " The Python program writes the port number in Xportnr. 75 call delete("Xportnr") 76 77 if len(a:args) == 1 78 let arg = ' ' . a:args[0] 79 else 80 let arg = '' 81 endif 82 let pycmd = s:python . " " . a:cmd . arg 83 84 try 85 let g:currentJob = RunCommand(pycmd) 86 87 " Wait for up to 2 seconds for the port number to be there. 88 let port = GetPort() 89 if port == 0 90 call assert_false(1, "Can't start " . a:cmd) 91 return 92 endif 93 94 call call(function(a:testfunc), [port]) 95 catch 96 call assert_false(1, 'Caught exception: "' . v:exception . '" in ' . v:throwpoint) 97 finally 98 call s:kill_server(a:cmd) 99 endtry 100endfunc 101 102func s:kill_server(cmd) 103 if has('job') 104 if exists('g:currentJob') 105 call job_stop(g:currentJob) 106 unlet g:currentJob 107 endif 108 elseif has('win32') 109 let cmd = substitute(a:cmd, ".py", '', '') 110 call system('taskkill /IM ' . s:python . ' /T /F /FI "WINDOWTITLE eq ' . cmd . '"') 111 else 112 call system("pkill -f " . a:cmd) 113 endif 114endfunc 115 116" Wait for up to a second for "expr" to become true. "expr" can be a 117" stringified expression to evaluate, or a funcref without arguments. 118" A second argument can be used to specify a different timeout in msec. 119" 120" Return time slept in milliseconds. With the +reltime feature this can be 121" more than the actual waiting time. Without +reltime it can also be less. 122func WaitFor(expr, ...) 123 let timeout = get(a:000, 0, 1000) 124 " using reltime() is more accurate, but not always available 125 if has('reltime') 126 let start = reltime() 127 else 128 let slept = 0 129 endif 130 if type(a:expr) == v:t_func 131 let Test = a:expr 132 else 133 let Test = {-> eval(a:expr) } 134 endif 135 for i in range(timeout / 10) 136 if Test() 137 if has('reltime') 138 return float2nr(reltimefloat(reltime(start)) * 1000) 139 endif 140 return slept 141 endif 142 if !has('reltime') 143 let slept += 10 144 endif 145 sleep 10m 146 endfor 147 throw 'WaitFor() timed out after ' . timeout . ' msec' 148endfunc 149 150" Wait for up to a given milliseconds. 151" With the +timers feature this waits for key-input by getchar(), Resume() 152" feeds key-input and resumes process. Return time waited in milliseconds. 153" Without +timers it uses simply :sleep. 154func Standby(msec) 155 if has('timers') 156 let start = reltime() 157 let g:_standby_timer = timer_start(a:msec, function('s:feedkeys')) 158 call getchar() 159 return float2nr(reltimefloat(reltime(start)) * 1000) 160 else 161 execute 'sleep ' a:msec . 'm' 162 return a:msec 163 endif 164endfunc 165 166func Resume() 167 if exists('g:_standby_timer') 168 call timer_stop(g:_standby_timer) 169 call s:feedkeys(0) 170 unlet g:_standby_timer 171 endif 172endfunc 173 174func s:feedkeys(timer) 175 call feedkeys('x', 'nt') 176endfunc 177 178" Get $VIMPROG to run Vim executable. 179" The Makefile writes it as the first line in the "vimcmd" file. 180func GetVimProg() 181 if !filereadable('vimcmd') 182 " Assume the script was sourced instead of running "make". 183 return '../vim' 184 endif 185 return readfile('vimcmd')[0] 186endfunc 187 188" Get the command to run Vim, with -u NONE and --not-a-term arguments. 189" If there is an argument use it instead of "NONE". 190func GetVimCommand(...) 191 if !filereadable('vimcmd') 192 echo 'Cannot read the "vimcmd" file, falling back to ../vim.' 193 let lines = ['../vim'] 194 else 195 let lines = readfile('vimcmd') 196 endif 197 if a:0 == 0 198 let name = 'NONE' 199 else 200 let name = a:1 201 endif 202 " For Unix Makefile writes the command to use in the second line of the 203 " "vimcmd" file, including environment options. 204 " Other Makefiles just write the executable in the first line, so fall back 205 " to that if there is no second line. 206 let cmd = get(lines, 1, lines[0]) 207 let cmd = substitute(cmd, '-u \f\+', '-u ' . name, '') 208 if cmd !~ '-u '. name 209 let cmd = cmd . ' -u ' . name 210 endif 211 let cmd .= ' --not-a-term' 212 let cmd = substitute(cmd, 'VIMRUNTIME=.*VIMRUNTIME;', '', '') 213 return cmd 214endfunc 215 216" Get the command to run Vim, with --clean. 217func GetVimCommandClean() 218 let cmd = GetVimCommand() 219 let cmd = substitute(cmd, '-u NONE', '--clean', '') 220 let cmd = substitute(cmd, '--not-a-term', '', '') 221 return cmd 222endfunc 223 224" Run Vim, using the "vimcmd" file and "-u NORC". 225" "before" is a list of Vim commands to be executed before loading plugins. 226" "after" is a list of Vim commands to be executed after loading plugins. 227" Plugins are not loaded, unless 'loadplugins' is set in "before". 228" Return 1 if Vim could be executed. 229func RunVim(before, after, arguments) 230 return RunVimPiped(a:before, a:after, a:arguments, '') 231endfunc 232 233func RunVimPiped(before, after, arguments, pipecmd) 234 let cmd = GetVimCommand() 235 if cmd == '' 236 return 0 237 endif 238 let args = '' 239 if len(a:before) > 0 240 call writefile(a:before, 'Xbefore.vim') 241 let args .= ' --cmd "so Xbefore.vim"' 242 endif 243 if len(a:after) > 0 244 call writefile(a:after, 'Xafter.vim') 245 let args .= ' -S Xafter.vim' 246 endif 247 248 exe "silent !" . a:pipecmd . cmd . args . ' ' . a:arguments 249 250 if len(a:before) > 0 251 call delete('Xbefore.vim') 252 endif 253 if len(a:after) > 0 254 call delete('Xafter.vim') 255 endif 256 return 1 257endfunc 258 259func CanRunGui() 260 return has('gui') && ($DISPLAY != "" || has('gui_running')) 261endfunc 262 263func WorkingClipboard() 264 if !has('clipboard') 265 return 0 266 endif 267 if has('x11') 268 return $DISPLAY != "" 269 endif 270 return 1 271endfunc 272 273" Get line "lnum" as displayed on the screen. 274" Trailing white space is trimmed. 275func! Screenline(lnum) 276 let chars = [] 277 for c in range(1, winwidth(0)) 278 call add(chars, nr2char(screenchar(a:lnum, c))) 279 endfor 280 let line = join(chars, '') 281 return matchstr(line, '^.\{-}\ze\s*$') 282endfunc 283 284" Stops the shell running in terminal "buf". 285func Stop_shell_in_terminal(buf) 286 call term_sendkeys(a:buf, "exit\r") 287 let job = term_getjob(a:buf) 288 call WaitFor({-> job_status(job) == "dead"}) 289endfunc 290