Bram Moolenaar | 07282f0 | 2019-10-10 16:46:17 +0200 | [diff] [blame] | 1 | source shared.vim |
Bram Moolenaar | 3180fe6 | 2020-02-02 13:47:06 +0100 | [diff] [blame] | 2 | source term_util.vim |
Bram Moolenaar | 07282f0 | 2019-10-10 16:46:17 +0200 | [diff] [blame] | 3 | |
Bram Moolenaar | 7f829ca | 2020-01-31 22:12:41 +0100 | [diff] [blame] | 4 | command -nargs=1 MissingFeature throw 'Skipped: ' .. <args> .. ' feature missing' |
| 5 | |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 6 | " Command to check for the presence of a feature. |
| 7 | command -nargs=1 CheckFeature call CheckFeature(<f-args>) |
| 8 | func CheckFeature(name) |
Bram Moolenaar | 7929651 | 2020-03-22 16:17:14 +0100 | [diff] [blame] | 9 | if !has(a:name, 1) |
| 10 | throw 'Checking for non-existent feature ' .. a:name |
| 11 | endif |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 12 | if !has(a:name) |
Bram Moolenaar | 7f829ca | 2020-01-31 22:12:41 +0100 | [diff] [blame] | 13 | MissingFeature a:name |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 14 | endif |
| 15 | endfunc |
| 16 | |
Bram Moolenaar | fb773a3 | 2021-07-03 21:37:59 +0200 | [diff] [blame] | 17 | " Command to check for the absence of a feature. |
| 18 | command -nargs=1 CheckNotFeature call CheckNotFeature(<f-args>) |
| 19 | func CheckNotFeature(name) |
| 20 | if !has(a:name, 1) |
| 21 | throw 'Checking for non-existent feature ' .. a:name |
| 22 | endif |
| 23 | if has(a:name) |
| 24 | throw 'Skipped: ' .. a:name .. ' feature present' |
| 25 | endif |
| 26 | endfunc |
| 27 | |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 28 | " Command to check for the presence of a working option. |
| 29 | command -nargs=1 CheckOption call CheckOption(<f-args>) |
| 30 | func CheckOption(name) |
Bram Moolenaar | c5a8fdc | 2020-03-22 20:13:39 +0100 | [diff] [blame] | 31 | if !exists('&' .. a:name) |
| 32 | throw 'Checking for non-existent option ' .. a:name |
| 33 | endif |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 34 | if !exists('+' .. a:name) |
| 35 | throw 'Skipped: ' .. a:name .. ' option not supported' |
| 36 | endif |
| 37 | endfunc |
| 38 | |
Bram Moolenaar | 15c4760 | 2020-03-26 22:16:48 +0100 | [diff] [blame] | 39 | " Command to check for the presence of a built-in function. |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 40 | command -nargs=1 CheckFunction call CheckFunction(<f-args>) |
| 41 | func CheckFunction(name) |
Bram Moolenaar | 15c4760 | 2020-03-26 22:16:48 +0100 | [diff] [blame] | 42 | if !exists('?' .. a:name) |
| 43 | throw 'Checking for non-existent function ' .. a:name |
| 44 | endif |
Bram Moolenaar | b46fecd | 2019-06-15 17:58:09 +0200 | [diff] [blame] | 45 | if !exists('*' .. a:name) |
| 46 | throw 'Skipped: ' .. a:name .. ' function missing' |
| 47 | endif |
| 48 | endfunc |
Bram Moolenaar | 4641a12 | 2019-07-29 22:10:23 +0200 | [diff] [blame] | 49 | |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 50 | " Command to check for the presence of an Ex command |
| 51 | command -nargs=1 CheckCommand call CheckCommand(<f-args>) |
| 52 | func CheckCommand(name) |
| 53 | if !exists(':' .. a:name) |
| 54 | throw 'Skipped: ' .. a:name .. ' command not supported' |
| 55 | endif |
| 56 | endfunc |
| 57 | |
| 58 | " Command to check for the presence of a shell command |
| 59 | command -nargs=1 CheckExecutable call CheckExecutable(<f-args>) |
| 60 | func CheckExecutable(name) |
| 61 | if !executable(a:name) |
| 62 | throw 'Skipped: ' .. a:name .. ' program not executable' |
| 63 | endif |
| 64 | endfunc |
| 65 | |
Bram Moolenaar | a161cb5 | 2020-04-30 19:09:35 +0200 | [diff] [blame] | 66 | " Command to check for the presence of python. Argument should have been |
| 67 | " obtained with PythonProg() |
| 68 | func CheckPython(name) |
| 69 | if a:name == '' |
| 70 | throw 'Skipped: python command not available' |
| 71 | endif |
| 72 | endfunc |
| 73 | |
Bram Moolenaar | 4641a12 | 2019-07-29 22:10:23 +0200 | [diff] [blame] | 74 | " Command to check for running on MS-Windows |
| 75 | command CheckMSWindows call CheckMSWindows() |
| 76 | func CheckMSWindows() |
| 77 | if !has('win32') |
| 78 | throw 'Skipped: only works on MS-Windows' |
| 79 | endif |
| 80 | endfunc |
| 81 | |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 82 | " Command to check for NOT running on MS-Windows |
| 83 | command CheckNotMSWindows call CheckNotMSWindows() |
| 84 | func CheckNotMSWindows() |
| 85 | if has('win32') |
| 86 | throw 'Skipped: does not work on MS-Windows' |
| 87 | endif |
| 88 | endfunc |
| 89 | |
Bram Moolenaar | 4641a12 | 2019-07-29 22:10:23 +0200 | [diff] [blame] | 90 | " Command to check for running on Unix |
| 91 | command CheckUnix call CheckUnix() |
| 92 | func CheckUnix() |
| 93 | if !has('unix') |
| 94 | throw 'Skipped: only works on Unix' |
| 95 | endif |
| 96 | endfunc |
Bram Moolenaar | 3c8ee62 | 2019-08-03 22:55:50 +0200 | [diff] [blame] | 97 | |
LemonBoy | cc766a8 | 2022-04-04 15:46:58 +0100 | [diff] [blame] | 98 | " Command to check for running on Linux |
Bram Moolenaar | 6635ae1 | 2021-03-10 21:46:39 +0100 | [diff] [blame] | 99 | command CheckLinux call CheckLinux() |
| 100 | func CheckLinux() |
| 101 | if !has('linux') |
| 102 | throw 'Skipped: only works on Linux' |
| 103 | endif |
| 104 | endfunc |
| 105 | |
Bram Moolenaar | 8b9abfd | 2021-03-29 20:49:05 +0200 | [diff] [blame] | 106 | " Command to check for not running on a BSD system. |
| 107 | command CheckNotBSD call CheckNotBSD() |
| 108 | func CheckNotBSD() |
| 109 | if has('bsd') |
| 110 | throw 'Skipped: does not work on BSD' |
| 111 | endif |
| 112 | endfunc |
| 113 | |
Bram Moolenaar | f802767 | 2022-09-27 15:55:43 +0100 | [diff] [blame] | 114 | " Command to check for not running on a MacOS |
| 115 | command CheckNotMac call CheckNotMac() |
| 116 | func CheckNotMac() |
| 117 | if has('mac') |
| 118 | throw 'Skipped: does not work on MacOS' |
| 119 | endif |
| 120 | endfunc |
| 121 | |
Bram Moolenaar | 0056ca7 | 2022-09-23 21:26:39 +0100 | [diff] [blame] | 122 | " Command to check for not running on a MacOS M1 system. |
| 123 | command CheckNotMacM1 call CheckNotMacM1() |
| 124 | func CheckNotMacM1() |
| 125 | if has('mac') && system('uname -a') =~ '\<arm64\>' |
| 126 | throw 'Skipped: does not work on MacOS M1' |
| 127 | endif |
| 128 | endfunc |
| 129 | |
Drew Vogel | ea67ba7 | 2025-05-07 22:05:17 +0200 | [diff] [blame] | 130 | func SetupWindowSizeToForVisualDumps() |
| 131 | " The dumps used as reference in these tests were created with a terminal |
| 132 | " width of 75 columns. The vim window that uses the remainder of the GUI |
| 133 | " window width must be at least 3 columns. In theory this means we need the |
| 134 | " GUI shell to provide 78+ columns. However the GTK3 resize logic is flaky, |
| 135 | " sometimes resulting in X11 Configure events that are narrower than |
| 136 | " expected by a number of pixels equal to 2 column widths. Therefore |
| 137 | " setting 80 columns ensures that the GUI shell can still provide 78+ |
| 138 | " columns. This is very likely papering over a GTK3 resize bug but one that |
| 139 | " has existed for a very long time. Establishing this workaround is meant to |
| 140 | " get the GTK3 code working under CI so that we can focus on removing this |
| 141 | " over the long term. |
| 142 | if &columns != 80 |
| 143 | set columns=80 |
| 144 | endif |
| 145 | " Without resetting lines, some GTK3 resize events can carry over between |
| 146 | " tests, which invalidate assumptions in the scrollbar offset calculations. |
| 147 | if &lines != 25 |
| 148 | set lines=25 |
| 149 | endif |
| 150 | endfunc |
| 151 | |
Bram Moolenaar | 3c8ee62 | 2019-08-03 22:55:50 +0200 | [diff] [blame] | 152 | " Command to check that making screendumps is supported. |
| 153 | " Caller must source screendump.vim |
| 154 | command CheckScreendump call CheckScreendump() |
| 155 | func CheckScreendump() |
Drew Vogel | ea67ba7 | 2025-05-07 22:05:17 +0200 | [diff] [blame] | 156 | let g:check_screendump_called = v:true |
Bram Moolenaar | 3c8ee62 | 2019-08-03 22:55:50 +0200 | [diff] [blame] | 157 | if !CanRunVimInTerminal() |
| 158 | throw 'Skipped: cannot make screendumps' |
| 159 | endif |
Drew Vogel | ea67ba7 | 2025-05-07 22:05:17 +0200 | [diff] [blame] | 160 | if has('gui_running') |
| 161 | call SetupWindowSizeToForVisualDumps() |
| 162 | endif |
Bram Moolenaar | 3c8ee62 | 2019-08-03 22:55:50 +0200 | [diff] [blame] | 163 | endfunc |
| 164 | |
| 165 | " Command to check that we can Run Vim in a terminal window |
| 166 | command CheckRunVimInTerminal call CheckRunVimInTerminal() |
| 167 | func CheckRunVimInTerminal() |
| 168 | if !CanRunVimInTerminal() |
| 169 | throw 'Skipped: cannot run Vim in a terminal window' |
| 170 | endif |
| 171 | endfunc |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 172 | |
| 173 | " Command to check that we can run the GUI |
| 174 | command CheckCanRunGui call CheckCanRunGui() |
| 175 | func CheckCanRunGui() |
| 176 | if !has('gui') || ($DISPLAY == "" && !has('gui_running')) |
Bram Moolenaar | 2514315 | 2019-08-09 14:13:57 +0200 | [diff] [blame] | 177 | throw 'Skipped: cannot start the GUI' |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 178 | endif |
| 179 | endfunc |
| 180 | |
Bram Moolenaar | d6fa7bd | 2021-07-05 14:10:04 +0200 | [diff] [blame] | 181 | " Command to Check for an environment variable |
| 182 | command -nargs=1 CheckEnv call CheckEnv(<f-args>) |
| 183 | func CheckEnv(name) |
Bram Moolenaar | f6d8779 | 2021-07-05 17:49:02 +0200 | [diff] [blame] | 184 | if empty(eval('$' .. a:name)) |
Bram Moolenaar | d6fa7bd | 2021-07-05 14:10:04 +0200 | [diff] [blame] | 185 | throw 'Skipped: Environment variable ' .. a:name .. ' is not set' |
| 186 | endif |
| 187 | endfunc |
| 188 | |
lilydjwg | 6e0a18f | 2024-01-29 20:54:28 +0100 | [diff] [blame] | 189 | " Command to Check for pure X11 (no Wayland) |
| 190 | command -nargs=0 CheckX11 call CheckX11() |
| 191 | func CheckX11() |
| 192 | if !empty($WAYLAND_DISPLAY) || empty($DISPLAY) |
| 193 | throw 'Skipped: not pure X11 environment' |
| 194 | endif |
| 195 | endfunc |
| 196 | |
Bram Moolenaar | 8c5a278 | 2019-08-07 23:07:07 +0200 | [diff] [blame] | 197 | " Command to check that we are using the GUI |
| 198 | command CheckGui call CheckGui() |
| 199 | func CheckGui() |
| 200 | if !has('gui_running') |
| 201 | throw 'Skipped: only works in the GUI' |
| 202 | endif |
| 203 | endfunc |
| 204 | |
| 205 | " Command to check that not currently using the GUI |
| 206 | command CheckNotGui call CheckNotGui() |
| 207 | func CheckNotGui() |
| 208 | if has('gui_running') |
| 209 | throw 'Skipped: only works in the terminal' |
| 210 | endif |
| 211 | endfunc |
Bram Moolenaar | 07282f0 | 2019-10-10 16:46:17 +0200 | [diff] [blame] | 212 | |
| 213 | " Command to check that test is not running as root |
| 214 | command CheckNotRoot call CheckNotRoot() |
| 215 | func CheckNotRoot() |
| 216 | if IsRoot() |
| 217 | throw 'Skipped: cannot run test as root' |
| 218 | endif |
| 219 | endfunc |
Bram Moolenaar | cde0ff3 | 2020-04-04 14:00:39 +0200 | [diff] [blame] | 220 | |
| 221 | " Command to check that the current language is English |
| 222 | command CheckEnglish call CheckEnglish() |
| 223 | func CheckEnglish() |
| 224 | if v:lang != "C" && v:lang !~ '^[Ee]n' |
| 225 | throw 'Skipped: only works in English language environment' |
| 226 | endif |
| 227 | endfunc |
| 228 | |
Bram Moolenaar | bfe13cc | 2020-04-12 17:53:12 +0200 | [diff] [blame] | 229 | " Command to check that loopback device has IPv6 address |
| 230 | command CheckIPv6 call CheckIPv6() |
| 231 | func CheckIPv6() |
| 232 | if !has('ipv6') |
| 233 | throw 'Skipped: cannot use IPv6 networking' |
| 234 | endif |
| 235 | if !exists('s:ipv6_loopback') |
| 236 | let s:ipv6_loopback = s:CheckIPv6Loopback() |
| 237 | endif |
| 238 | if !s:ipv6_loopback |
| 239 | throw 'Skipped: no IPv6 address for loopback device' |
| 240 | endif |
| 241 | endfunc |
| 242 | |
| 243 | func s:CheckIPv6Loopback() |
| 244 | if has('win32') |
| 245 | return system('netsh interface ipv6 show interface') =~? '\<Loopback\>' |
| 246 | elseif filereadable('/proc/net/if_inet6') |
| 247 | return (match(readfile('/proc/net/if_inet6'), '\slo$') >= 0) |
| 248 | elseif executable('ifconfig') |
| 249 | for dev in ['lo0', 'lo', 'loop'] |
| 250 | " NOTE: On SunOS, need specify address family 'inet6' to get IPv6 info. |
| 251 | if system('ifconfig ' .. dev .. ' inet6 2>/dev/null') =~? '\<inet6\>' |
| 252 | \ || system('ifconfig ' .. dev .. ' 2>/dev/null') =~? '\<inet6\>' |
| 253 | return v:true |
| 254 | endif |
| 255 | endfor |
| 256 | else |
| 257 | " TODO: How to check it in other platforms? |
| 258 | endif |
| 259 | return v:false |
| 260 | endfunc |
| 261 | |
Bram Moolenaar | 97202d9 | 2021-01-28 18:34:35 +0100 | [diff] [blame] | 262 | " Command to check for not running under ASAN |
| 263 | command CheckNotAsan call CheckNotAsan() |
| 264 | func CheckNotAsan() |
| 265 | if execute('version') =~# '-fsanitize=[a-z,]*\<address\>' |
| 266 | throw 'Skipped: does not work with ASAN' |
| 267 | endif |
| 268 | endfunc |
| 269 | |
Bram Moolenaar | cf801d4 | 2022-06-21 18:34:42 +0100 | [diff] [blame] | 270 | " Command to check for not running under valgrind |
| 271 | command CheckNotValgrind call CheckNotValgrind() |
| 272 | func CheckNotValgrind() |
| 273 | if RunningWithValgrind() |
| 274 | throw 'Skipped: does not work well with valgrind' |
| 275 | endif |
| 276 | endfunc |
| 277 | |
Bram Moolenaar | 40bd5a1 | 2021-10-16 21:58:27 +0100 | [diff] [blame] | 278 | " Command to check for X11 based GUI |
| 279 | command CheckX11BasedGui call CheckX11BasedGui() |
| 280 | func CheckX11BasedGui() |
| 281 | if !g:x11_based_gui |
| 282 | throw 'Skipped: requires X11 based GUI' |
| 283 | endif |
| 284 | endfunc |
| 285 | |
Ernie Rael | 559f230 | 2022-07-26 14:44:36 +0100 | [diff] [blame] | 286 | " Command to check that there are two clipboards |
| 287 | command CheckTwoClipboards call CheckTwoClipboards() |
| 288 | func CheckTwoClipboards() |
| 289 | " avoid changing the clipboard here, only X11 supports both |
| 290 | if !has('X11') |
| 291 | throw 'Skipped: requires two clipboards' |
| 292 | endif |
| 293 | endfunc |
| 294 | |
Bram Moolenaar | f8c52e8 | 2021-03-17 12:27:23 +0100 | [diff] [blame] | 295 | " Command to check for satisfying any of the conditions. |
| 296 | " e.g. CheckAnyOf Feature:bsd Feature:sun Linux |
| 297 | command -nargs=+ CheckAnyOf call CheckAnyOf(<f-args>) |
| 298 | func CheckAnyOf(...) |
| 299 | let excp = [] |
| 300 | for arg in a:000 |
| 301 | try |
| 302 | exe 'Check' .. substitute(arg, ':', ' ', '') |
| 303 | return |
| 304 | catch /^Skipped:/ |
| 305 | let excp += [substitute(v:exception, '^Skipped:\s*', '', '')] |
| 306 | endtry |
| 307 | endfor |
| 308 | throw 'Skipped: ' .. join(excp, '; ') |
| 309 | endfunc |
| 310 | |
| 311 | " Command to check for satisfying all of the conditions. |
| 312 | " e.g. CheckAllOf Unix Gui Option:ballooneval |
| 313 | command -nargs=+ CheckAllOf call CheckAllOf(<f-args>) |
| 314 | func CheckAllOf(...) |
| 315 | for arg in a:000 |
| 316 | exe 'Check' .. substitute(arg, ':', ' ', '') |
| 317 | endfor |
| 318 | endfunc |
| 319 | |
Christian Brabandt | 6f14ef4 | 2025-02-09 17:05:21 +0100 | [diff] [blame] | 320 | " Check if running under Github Actions |
| 321 | command CheckGithubActions call CheckGithubActions() |
| 322 | func CheckGithubActions() |
| 323 | if expand('$GITHUB_ACTIONS') ==# 'true' |
| 324 | throw "Skipped: FIXME: this test doesn't work on Github Actions CI" |
| 325 | endif |
| 326 | endfunc |
Bram Moolenaar | cde0ff3 | 2020-04-04 14:00:39 +0200 | [diff] [blame] | 327 | " vim: shiftwidth=2 sts=2 expandtab |