1" Test for :match, :2match, :3match, clearmatches(), getmatches(), matchadd(), 2" matchaddpos(), matcharg(), matchdelete(), and setmatches(). 3 4source screendump.vim 5source check.vim 6 7function Test_match() 8 highlight MyGroup1 term=bold ctermbg=red guibg=red 9 highlight MyGroup2 term=italic ctermbg=green guibg=green 10 highlight MyGroup3 term=underline ctermbg=blue guibg=blue 11 12 " --- Check that "matcharg()" returns the correct group and pattern if a match 13 " --- is defined. 14 match MyGroup1 /TODO/ 15 2match MyGroup2 /FIXME/ 16 3match MyGroup3 /XXX/ 17 call assert_equal(['MyGroup1', 'TODO'], matcharg(1)) 18 call assert_equal(['MyGroup2', 'FIXME'], 2->matcharg()) 19 call assert_equal(['MyGroup3', 'XXX'], matcharg(3)) 20 21 " --- Check that "matcharg()" returns an empty list if the argument is not 1, 22 " --- 2 or 3 (only 0 and 4 are tested). 23 call assert_equal([], matcharg(0)) 24 call assert_equal([], matcharg(4)) 25 26 " --- Check that "matcharg()" returns ['', ''] if a match is not defined. 27 match 28 2match 29 3match 30 call assert_equal(['', ''], matcharg(1)) 31 call assert_equal(['', ''], matcharg(2)) 32 call assert_equal(['', ''], matcharg(3)) 33 34 " --- Check that "matchadd()" and "getmatches()" agree on added matches and 35 " --- that default values apply. 36 let m1 = matchadd("MyGroup1", "TODO") 37 let m2 = matchadd("MyGroup2", "FIXME", 42) 38 let m3 = matchadd("MyGroup3", "XXX", 60, 17) 39 let ans = [{'group': 'MyGroup1', 'pattern': 'TODO', 'priority': 10, 'id': 4}, 40 \ {'group': 'MyGroup2', 'pattern': 'FIXME', 'priority': 42, 'id': 5}, 41 \ {'group': 'MyGroup3', 'pattern': 'XXX', 'priority': 60, 'id': 17}] 42 call assert_equal(ans, getmatches()) 43 44 " --- Check that "matchdelete()" deletes the matches defined in the previous 45 " --- test correctly. 46 call matchdelete(m1) 47 eval m2->matchdelete() 48 call matchdelete(m3) 49 call assert_equal([], getmatches()) 50 51 " --- Check that "matchdelete()" returns 0 if successful and otherwise -1. 52 let m = matchadd("MyGroup1", "TODO") 53 call assert_equal(0, matchdelete(m)) 54 call assert_fails('call matchdelete(42)', 'E803:') 55 56 " --- Check that "clearmatches()" clears all matches defined by ":match" and 57 " --- "matchadd()". 58 let m1 = matchadd("MyGroup1", "TODO") 59 let m2 = "MyGroup2"->matchadd("FIXME", 42) 60 let m3 = matchadd("MyGroup3", "XXX", 60, 17) 61 match MyGroup1 /COFFEE/ 62 2match MyGroup2 /HUMPPA/ 63 3match MyGroup3 /VIM/ 64 call clearmatches() 65 call assert_equal([], getmatches()) 66 67 " --- Check that "setmatches()" restores a list of matches saved by 68 " --- "getmatches()" without changes. (Matches with equal priority must also 69 " --- remain in the same order.) 70 let m1 = matchadd("MyGroup1", "TODO") 71 let m2 = matchadd("MyGroup2", "FIXME", 42) 72 let m3 = matchadd("MyGroup3", "XXX", 60, 17) 73 match MyGroup1 /COFFEE/ 74 2match MyGroup2 /HUMPPA/ 75 3match MyGroup3 /VIM/ 76 let ml = getmatches() 77 call clearmatches() 78 call setmatches(ml) 79 call assert_equal(ml, getmatches()) 80 call clearmatches() 81 82 " --- Check that "setmatches()" will not add two matches with the same ID. The 83 " --- expected behaviour (for now) is to add the first match but not the 84 " --- second and to return 0 (even though it is a matter of debate whether 85 " --- this can be considered successful behaviour). 86 let data = [{'group': 'MyGroup1', 'pattern': 'TODO', 'priority': 10, 'id': 1}, 87 \ {'group': 'MyGroup2', 'pattern': 'FIXME', 'priority': 10, 'id': 1}] 88 call assert_fails('call setmatches(data)', 'E801:') 89 call assert_equal([data[0]], getmatches()) 90 call clearmatches() 91 92 " --- Check that "setmatches()" returns 0 if successful and otherwise -1. 93 " --- (A range of valid and invalid input values are tried out to generate the 94 " --- return values.) 95 call assert_equal(0, setmatches([])) 96 call assert_equal(0, setmatches([{'group': 'MyGroup1', 'pattern': 'TODO', 'priority': 10, 'id': 1}])) 97 call clearmatches() 98 call assert_fails('call setmatches(0)', 'E714:') 99 call assert_fails('call setmatches([0])', 'E474:') 100 call assert_fails("call setmatches([{'wrong key': 'wrong value'}])", 'E474:') 101 102 call setline(1, 'abcdefghijklmnopq') 103 call matchaddpos("MyGroup1", [[1, 5], [1, 8, 3]], 10, 3) 104 1 105 redraw! 106 let v1 = screenattr(1, 1) 107 let v5 = screenattr(1, 5) 108 let v6 = screenattr(1, 6) 109 let v8 = screenattr(1, 8) 110 let v10 = screenattr(1, 10) 111 let v11 = screenattr(1, 11) 112 call assert_notequal(v1, v5) 113 call assert_equal(v6, v1) 114 call assert_equal(v8, v5) 115 call assert_equal(v10, v5) 116 call assert_equal(v11, v1) 117 call assert_equal([{'group': 'MyGroup1', 'id': 3, 'priority': 10, 'pos1': [1, 5, 1], 'pos2': [1, 8, 3]}], getmatches()) 118 call clearmatches() 119 120 call setline(1, 'abcdΣabcdef') 121 eval "MyGroup1"->matchaddpos([[1, 4, 2], [1, 9, 2]]) 122 1 123 redraw! 124 let v1 = screenattr(1, 1) 125 let v4 = screenattr(1, 4) 126 let v5 = screenattr(1, 5) 127 let v6 = screenattr(1, 6) 128 let v7 = screenattr(1, 7) 129 let v8 = screenattr(1, 8) 130 let v9 = screenattr(1, 9) 131 let v10 = screenattr(1, 10) 132 call assert_equal([{'group': 'MyGroup1', 'id': 11, 'priority': 10, 'pos1': [1, 4, 2], 'pos2': [1, 9, 2]}], getmatches()) 133 call assert_notequal(v1, v4) 134 call assert_equal(v5, v4) 135 call assert_equal(v6, v1) 136 call assert_equal(v7, v1) 137 call assert_equal(v8, v4) 138 call assert_equal(v9, v4) 139 call assert_equal(v10, v1) 140 141 " Check, that setmatches() can correctly restore the matches from matchaddpos() 142 call matchadd('MyGroup1', '\%2lmatchadd') 143 let m=getmatches() 144 call clearmatches() 145 call setmatches(m) 146 call assert_equal([{'group': 'MyGroup1', 'id': 11, 'priority': 10, 'pos1': [1, 4, 2], 'pos2': [1,9, 2]}, {'group': 'MyGroup1', 'pattern': '\%2lmatchadd', 'priority': 10, 'id': 12}], getmatches()) 147 148 highlight MyGroup1 NONE 149 highlight MyGroup2 NONE 150 highlight MyGroup3 NONE 151endfunc 152 153func Test_match_error() 154 call assert_fails('match Error', 'E475:') 155 call assert_fails('match Error /', 'E475:') 156 call assert_fails('4match Error /x/', 'E476:') 157 call assert_fails('match Error /x/ x', 'E488:') 158endfunc 159 160func Test_matchadd_error() 161 call assert_fails("call matchadd('GroupDoesNotExist', 'X')", 'E28:') 162 call assert_fails("call matchadd('Search', '\\(')", 'E475:') 163 call assert_fails("call matchadd('Search', 'XXX', 1, 123, 1)", 'E715:') 164 call assert_fails("call matchadd('Error', 'XXX', 1, 3)", 'E798:') 165 call assert_fails("call matchadd('Error', 'XXX', 1, 0)", 'E799:') 166endfunc 167 168func Test_matchaddpos() 169 syntax on 170 set hlsearch 171 172 call setline(1, ['12345', 'NP']) 173 call matchaddpos('Error', [[1,2], [1,6], [2,2]]) 174 redraw! 175 call assert_notequal(screenattr(2,2), 0) 176 call assert_equal(screenattr(2,2), screenattr(1,2)) 177 call assert_notequal(screenattr(2,2), screenattr(1,6)) 178 1 179 call matchadd('Search', 'N\|\n') 180 redraw! 181 call assert_notequal(screenattr(2,1), 0) 182 call assert_equal(screenattr(2,1), screenattr(1,6)) 183 exec "norm! i0\<Esc>" 184 redraw! 185 call assert_equal(screenattr(2,2), screenattr(1,6)) 186 187 " Check overlapping pos 188 call clearmatches() 189 call setline(1, ['1234567890', 'NH']) 190 call matchaddpos('Error', [[1,1,5], [1,3,5], [2,2]]) 191 redraw! 192 call assert_notequal(screenattr(2,2), 0) 193 call assert_equal(screenattr(2,2), screenattr(1,5)) 194 call assert_equal(screenattr(2,2), screenattr(1,7)) 195 call assert_notequal(screenattr(2,2), screenattr(1,8)) 196 197 call clearmatches() 198 call matchaddpos('Error', [[1], [2,2]]) 199 redraw! 200 call assert_equal(screenattr(2,2), screenattr(1,1)) 201 call assert_equal(screenattr(2,2), screenattr(1,10)) 202 call assert_notequal(screenattr(2,2), screenattr(1,11)) 203 204 nohl 205 call clearmatches() 206 syntax off 207 set hlsearch& 208endfunc 209 210func Test_matchaddpos_otherwin() 211 syntax on 212 new 213 call setline(1, ['12345', 'NP']) 214 let winid = win_getid() 215 216 wincmd w 217 call matchadd('Search', '4', 10, -1, {'window': winid}) 218 call matchaddpos('Error', [[1,2], [2,2]], 10, -1, {'window': winid}) 219 redraw! 220 call assert_notequal(screenattr(1,2), 0) 221 call assert_notequal(screenattr(1,4), 0) 222 call assert_notequal(screenattr(2,2), 0) 223 call assert_equal(screenattr(1,2), screenattr(2,2)) 224 call assert_notequal(screenattr(1,2), screenattr(1,4)) 225 226 let savematches = getmatches(winid) 227 let expect = [ 228 \ {'group': 'Search', 'pattern': '4', 'priority': 10, 'id': 4}, 229 \ {'group': 'Error', 'id': 5, 'priority': 10, 'pos1': [1, 2, 1], 'pos2': [2, 2, 1]}, 230 \] 231 call assert_equal(expect, savematches) 232 233 eval winid->clearmatches() 234 call assert_equal([], getmatches(winid)) 235 236 call setmatches(savematches, winid) 237 call assert_equal(expect, savematches) 238 239 wincmd w 240 bwipe! 241 call clearmatches() 242 syntax off 243endfunc 244 245func Test_matchaddpos_using_negative_priority() 246 set hlsearch 247 248 call clearmatches() 249 250 call setline(1, 'x') 251 let @/='x' 252 redraw! 253 let search_attr = screenattr(1,1) 254 255 let @/='' 256 call matchaddpos('Error', [1], 10) 257 redraw! 258 let error_attr = screenattr(1,1) 259 260 call setline(2, '-1 match priority') 261 call matchaddpos('Error', [2], -1) 262 redraw! 263 let negative_match_priority_attr = screenattr(2,1) 264 265 call assert_notequal(negative_match_priority_attr, search_attr, "Match with negative priority is incorrectly highlighted with Search highlight.") 266 call assert_equal(negative_match_priority_attr, error_attr) 267 268 nohl 269 set hlsearch& 270endfunc 271 272func Test_matchaddpos_error() 273 call assert_fails("call matchaddpos('Error', 1)", 'E686:') 274 call assert_fails("call matchaddpos('Error', [1], 1, 1)", 'E798:') 275 call assert_fails("call matchaddpos('Error', [1], 1, 2)", 'E798:') 276 call assert_fails("call matchaddpos('Error', [1], 1, 0)", 'E799:') 277 call assert_fails("call matchaddpos('Error', [1], 1, 123, 1)", 'E715:') 278 call assert_fails("call matchaddpos('Error', [1], 1, 5, {'window':12345})", 'E957:') 279 " Why doesn't the following error have an error code E...? 280 call assert_fails("call matchaddpos('Error', [{}])", 'E290:') 281endfunc 282 283func OtherWindowCommon() 284 let lines =<< trim END 285 call setline(1, 'Hello Vim world') 286 let mid = matchadd('Error', 'world', 1) 287 let winid = win_getid() 288 new 289 END 290 call writefile(lines, 'XscriptMatchCommon') 291 let buf = RunVimInTerminal('-S XscriptMatchCommon', #{rows: 12}) 292 call TermWait(buf) 293 return buf 294endfunc 295 296func Test_matchdelete_other_window() 297 CheckScreendump 298 299 let buf = OtherWindowCommon() 300 call term_sendkeys(buf, ":call matchdelete(mid, winid)\<CR>") 301 call VerifyScreenDump(buf, 'Test_matchdelete_1', {}) 302 303 call StopVimInTerminal(buf) 304 call delete('XscriptMatchCommon') 305endfunc 306 307func Test_matchdelete_error() 308 call assert_fails("call matchdelete(0)", 'E802:') 309 call assert_fails("call matchdelete(1, -1)", 'E957:') 310endfunc 311 312func Test_matchclear_other_window() 313 if !CanRunVimInTerminal() 314 throw 'Skipped: cannot make screendumps' 315 endif 316 let buf = OtherWindowCommon() 317 call term_sendkeys(buf, ":call clearmatches(winid)\<CR>") 318 call VerifyScreenDump(buf, 'Test_matchclear_1', {}) 319 320 call StopVimInTerminal(buf) 321 call delete('XscriptMatchCommon') 322endfunc 323 324func Test_matchadd_other_window() 325 if !CanRunVimInTerminal() 326 throw 'Skipped: cannot make screendumps' 327 endif 328 let buf = OtherWindowCommon() 329 call term_sendkeys(buf, ":call matchadd('Search', 'Hello', 1, -1, #{window: winid})\<CR>") 330 call term_sendkeys(buf, ":\<CR>") 331 call VerifyScreenDump(buf, 'Test_matchadd_1', {}) 332 333 call StopVimInTerminal(buf) 334 call delete('XscriptMatchCommon') 335endfunc 336 337 338" vim: shiftwidth=2 sts=2 expandtab 339