xref: /vim-8.2.3635/src/testdir/test_signs.vim (revision 94688b8a)
1" Test for signs
2
3if !has('signs')
4  finish
5endif
6
7func Test_sign()
8  new
9  call setline(1, ['a', 'b', 'c', 'd'])
10
11  " Define some signs.
12  " We can specify icons even if not all versions of vim support icons as
13  " icon is ignored when not supported.  "(not supported)" is shown after
14  " the icon name when listing signs.
15  sign define Sign1 text=x
16  try
17    sign define Sign2 text=xy texthl=Title linehl=Error
18		\ icon=../../pixmaps/stock_vim_find_help.png
19  catch /E255:/
20    " Ignore error: E255: Couldn't read in sign data!
21    " This error can happen when running in the GUI.
22    " Some gui like Motif do not support the png icon format.
23  endtry
24
25  " Test listing signs.
26  let a=execute('sign list')
27  call assert_match('^\nsign Sign1 text=x \nsign Sign2 ' .
28	      \ 'icon=../../pixmaps/stock_vim_find_help.png .*text=xy ' .
29	      \ 'linehl=Error texthl=Title$', a)
30
31  let a=execute('sign list Sign1')
32  call assert_equal("\nsign Sign1 text=x ", a)
33
34  " Split the window to the bottom to verify sign jump will stay in the
35  " current window if the buffer is displayed there.
36  let bn = bufnr('%')
37  let wn = winnr()
38  exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
39  1
40  bot split
41  exe 'sign jump 41 buffer=' . bufnr('%')
42  call assert_equal('c', getline('.'))
43  call assert_equal(3, winnr())
44  call assert_equal(bn, bufnr('%'))
45  call assert_notequal(wn, winnr())
46
47  " Create a new buffer and check that ":sign jump" switches to the old buffer.
48  1
49  new foo
50  call assert_notequal(bn, bufnr('%'))
51  exe 'sign jump 41 buffer=' . bn
52  call assert_equal(bn, bufnr('%'))
53  call assert_equal('c', getline('.'))
54
55  " Redraw to make sure that screen redraw with sign gets exercised,
56  " with and without 'rightleft'.
57  if has('rightleft')
58    set rightleft
59    redraw
60    set norightleft
61  endif
62  redraw
63
64  " Check that we can't change sign.
65  call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
66
67  " Check placed signs
68  let a=execute('sign place')
69  call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
70		\ "    line=3  id=41  name=Sign1  priority=10\n", a)
71
72  " Unplace the sign and try jumping to it again should fail.
73  sign unplace 41
74  1
75  call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
76  call assert_equal('a', getline('.'))
77
78  " Unplace sign on current line.
79  exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
80  4
81  sign unplace
82  let a=execute('sign place')
83  call assert_equal("\n--- Signs ---\n", a)
84
85  " Try again to unplace sign on current line, it should fail this time.
86  call assert_fails('sign unplace', 'E159:')
87
88  " Unplace all signs.
89  exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
90  sign unplace *
91  let a=execute('sign place')
92  call assert_equal("\n--- Signs ---\n", a)
93
94  " Place a sign without specifying the filename or buffer
95  sign place 77 line=9 name=Sign2
96  let a=execute('sign place')
97  call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
98		\ "    line=9  id=77  name=Sign2  priority=10\n", a)
99  sign unplace *
100
101  " Check :jump with file=...
102  edit foo
103  call setline(1, ['A', 'B', 'C', 'D'])
104
105  try
106    sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist
107		\ icon=doesnotexist.xpm
108  catch /E255:/
109    " ignore error: E255: it can happens for guis.
110  endtry
111
112  let fn = expand('%:p')
113  exe 'sign place 43 line=2 name=Sign3 file=' . fn
114  edit bar
115  call assert_notequal(fn, expand('%:p'))
116  exe 'sign jump 43 file=' . fn
117  call assert_equal('B', getline('.'))
118
119  " Check for jumping to a sign in a hidden buffer
120  enew! | only!
121  edit foo
122  call setline(1, ['A', 'B', 'C', 'D'])
123  let fn = expand('%:p')
124  exe 'sign place 21 line=3 name=Sign3 file=' . fn
125  hide edit bar
126  exe 'sign jump 21 file=' . fn
127  call assert_equal('C', getline('.'))
128
129  " can't define a sign with a non-printable character as text
130  call assert_fails("sign define Sign4 text=\e linehl=Comment", 'E239:')
131  call assert_fails("sign define Sign4 text=a\e linehl=Comment", 'E239:')
132  call assert_fails("sign define Sign4 text=\ea linehl=Comment", 'E239:')
133
134  " Only 1 or 2 character text is allowed
135  call assert_fails("sign define Sign4 text=abc linehl=Comment", 'E239:')
136  call assert_fails("sign define Sign4 text= linehl=Comment", 'E239:')
137  call assert_fails("sign define Sign4 text=\\ ab  linehl=Comment", 'E239:')
138
139  " define sign with whitespace
140  sign define Sign4 text=\ X linehl=Comment
141  sign undefine Sign4
142  sign define Sign4 linehl=Comment text=\ X
143  sign undefine Sign4
144
145  sign define Sign5 text=X\  linehl=Comment
146  sign undefine Sign5
147  sign define Sign5 linehl=Comment text=X\
148  sign undefine Sign5
149
150  " define sign with backslash
151  sign define Sign4 text=\\\\ linehl=Comment
152  sign undefine Sign4
153  sign define Sign4 text=\\ linehl=Comment
154  sign undefine Sign4
155
156  " define a sign with a leading 0 in the name
157  sign unplace *
158  sign define 004 text=#> linehl=Comment
159  let a = execute('sign list 4')
160  call assert_equal("\nsign 4 text=#> linehl=Comment", a)
161  exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
162  let a = execute('sign place')
163  call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
164		\ "    line=3  id=20  name=4  priority=10\n", a)
165  exe 'sign unplace 20 buffer=' . bufnr('')
166  sign undefine 004
167  call assert_fails('sign list 4', 'E155:')
168
169  " After undefining the sign, we should no longer be able to place it.
170  sign undefine Sign1
171  sign undefine Sign2
172  sign undefine Sign3
173  call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
174			  \ bufnr('%'), 'E155:')
175endfunc
176
177" Undefining placed sign is not recommended.
178" Quoting :help sign
179"
180" :sign undefine {name}
181"                Deletes a previously defined sign.  If signs with this {name}
182"                are still placed this will cause trouble.
183func Test_sign_undefine_still_placed()
184  new foobar
185  sign define Sign text=x
186  exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
187  sign undefine Sign
188
189  " Listing placed sign should show that sign is deleted.
190  let a=execute('sign place')
191  call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
192		\ "    line=1  id=41  name=[Deleted]  priority=10\n", a)
193
194  sign unplace 41
195  let a=execute('sign place')
196  call assert_equal("\n--- Signs ---\n", a)
197endfunc
198
199func Test_sign_completion()
200  sign define Sign1 text=x
201  sign define Sign2 text=y
202
203  call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
204  call assert_equal('"sign define jump list place undefine unplace', @:)
205
206  call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
207  call assert_equal('"sign define Sign icon= linehl= text= texthl=', @:)
208
209  call feedkeys(":sign define Sign linehl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
210  call assert_equal('"sign define Sign linehl=SpellBad SpellCap ' .
211	      \ 'SpellLocal SpellRare', @:)
212
213  call writefile(['foo'], 'XsignOne')
214  call writefile(['bar'], 'XsignTwo')
215  call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
216  call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
217  call delete('XsignOne')
218  call delete('XsignTwo')
219
220  call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
221  call assert_equal('"sign undefine Sign1 Sign2', @:)
222
223  call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
224  call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
225	      \ @:)
226
227  call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
228  call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
229
230  call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
231  call assert_equal('"sign unplace 1 buffer= file= group=', @:)
232
233  call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
234  call assert_equal('"sign list Sign1 Sign2', @:)
235
236  call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
237  call assert_equal('"sign jump 1 buffer= file= group=', @:)
238
239  sign undefine Sign1
240  sign undefine Sign2
241endfunc
242
243func Test_sign_invalid_commands()
244  sign define Sign1 text=x
245
246  call assert_fails('sign', 'E471:')
247  call assert_fails('sign jump', 'E471:')
248  call assert_fails('sign xxx', 'E160:')
249  call assert_fails('sign define', 'E156:')
250  call assert_fails('sign define Sign1 xxx', 'E475:')
251  call assert_fails('sign undefine', 'E156:')
252  call assert_fails('sign list xxx', 'E155:')
253  call assert_fails('sign place 1 buffer=999', 'E158:')
254  call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
255  call assert_fails('sign place buffer=999', 'E158:')
256  call assert_fails('sign jump buffer=999', 'E158:')
257  call assert_fails('sign jump 1 file=', 'E158:')
258  call assert_fails('sign jump 1 group=', 'E474:')
259  call assert_fails('sign jump 1 name=', 'E474:')
260  call assert_fails('sign jump 1 name=Sign1', 'E474:')
261  call assert_fails('sign jump 1 line=100', '474:')
262  call assert_fails('sign define Sign2 text=', 'E239:')
263  " Non-numeric identifier for :sign place
264  call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
265								\ 'E474:')
266  " Non-numeric identifier for :sign unplace
267  call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
268								\ 'E474:')
269  " Number followed by an alphabet as sign identifier for :sign place
270  call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
271								\ 'E474:')
272  " Number followed by an alphabet as sign identifier for :sign unplace
273  call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
274								\ 'E474:')
275  " Sign identifier and '*' for :sign unplace
276  call assert_fails("sign unplace 2 *", 'E474:')
277  " Trailing characters after buffer number for :sign place
278  call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
279						\ bufnr('%') . 'xxx', 'E488:')
280  " Trailing characters after buffer number for :sign unplace
281  call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
282  call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
283  call assert_fails("sign unplace 1 xxx", 'E474:')
284  call assert_fails("sign unplace * xxx", 'E474:')
285  call assert_fails("sign unplace xxx", 'E474:')
286  " Placing a sign without line number
287  call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
288  " Placing a sign without sign name
289  call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
290  " Unplacing a sign with line number
291  call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
292  " Unplacing a sign with sign name
293  call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
294  " Placing a sign without sign name
295  call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
296  " Placing a sign with only sign identifier
297  call assert_fails("sign place 2", 'E474:')
298  " Placing a sign with only a name
299  call assert_fails("sign place abc", 'E474:')
300  " Placing a sign with only line number
301  call assert_fails("sign place 5 line=3", 'E474:')
302  " Placing a sign with only sign group
303  call assert_fails("sign place 5 group=g1", 'E474:')
304  call assert_fails("sign place 5 group=*", 'E474:')
305  " Placing a sign with only sign priority
306  call assert_fails("sign place 5 priority=10", 'E474:')
307
308  sign undefine Sign1
309endfunc
310
311func Test_sign_delete_buffer()
312  new
313  sign define Sign text=x
314  let bufnr = bufnr('%')
315  new
316  exe 'bd ' . bufnr
317  exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
318  call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
319  sign unplace 61
320  sign undefine Sign
321endfunc
322
323" Test for Vim script functions for managing signs
324func Test_sign_funcs()
325  " Remove all the signs
326  call sign_unplace('*')
327  call sign_undefine()
328
329  " Tests for sign_define()
330  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
331  call assert_equal(0, sign_define("sign1", attr))
332  call assert_equal([{'name' : 'sign1', 'texthl' : 'Error',
333	      \ 'linehl' : 'Search', 'text' : '=>'}], sign_getdefined())
334
335  " Define a new sign without attributes and then update it
336  call sign_define("sign2")
337  let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
338	      \ 'icon' : 'sign2.ico'}
339  try
340    call sign_define("sign2", attr)
341  catch /E255:/
342    " ignore error: E255: Couldn't read in sign data!
343    " This error can happen when running in gui.
344  endtry
345  call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
346	      \ 'linehl' : 'DiffAdd', 'text' : '!!', 'icon' : 'sign2.ico'}],
347	      \ sign_getdefined("sign2"))
348
349  " Test for a sign name with digits
350  call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
351  call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
352	      \ sign_getdefined(0002))
353  call sign_undefine(0002)
354
355  " Tests for invalid arguments to sign_define()
356  call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
357  call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
358  call assert_fails('call sign_define([])', 'E730:')
359  call assert_fails('call sign_define("sign6", [])', 'E715:')
360
361  " Tests for sign_getdefined()
362  call assert_equal([], sign_getdefined("none"))
363  call assert_fails('call sign_getdefined({})', 'E731:')
364
365  " Tests for sign_place()
366  call writefile(repeat(["Sun is shining"], 30), "Xsign")
367  edit Xsign
368
369  call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
370	      \ {'lnum' : 20}))
371  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
372	      \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
373	      \ 'priority' : 10}]}], sign_getplaced('Xsign'))
374  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
375	      \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
376	      \ 'priority' : 10}]}],
377	      \ sign_getplaced('%', {'lnum' : 20}))
378  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
379	      \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
380	      \ 'priority' : 10}]}],
381	      \ sign_getplaced('', {'id' : 10}))
382
383  " Tests for invalid arguments to sign_place()
384  call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
385  call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
386  call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])',
387	      \ 'E474:')
388  call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
389	      \ {"lnum" : 30})', 'E474:')
390  call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
391	      \ {"lnum" : 30})', 'E155:')
392  call assert_fails('call sign_place(10, "", "", "Xsign",
393	      \ {"lnum" : 30})', 'E155:')
394  call assert_fails('call sign_place(10, "", [], "Xsign",
395	      \ {"lnum" : 30})', 'E730:')
396  call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
397	      \ {"lnum" : 10})', 'E158:')
398  call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
399	      \ 'E158:')
400  call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
401	      \ 'E158:')
402  call assert_fails('call sign_place(21, "", "sign1", "Xsign",
403	      \ {"lnum" : -1})', 'E885:')
404  call assert_fails('call sign_place(22, "", "sign1", "Xsign",
405	      \ {"lnum" : 0})', 'E885:')
406  call assert_fails('call sign_place(22, "", "sign1", "Xsign",
407	      \ {"lnum" : []})', 'E745:')
408  call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
409
410  " Tests for sign_getplaced()
411  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
412	      \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
413	      \ 'priority' : 10}]}],
414	      \ sign_getplaced(bufnr('Xsign')))
415  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
416	      \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
417	      \ 'priority' : 10}]}],
418	      \ sign_getplaced())
419  call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
420  call assert_fails('call sign_getplaced("&")', 'E158:')
421  call assert_fails('call sign_getplaced(-1)', 'E158:')
422  call assert_fails('call sign_getplaced("Xsign", [])', 'E715:')
423  call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
424	      \ sign_getplaced('Xsign', {'lnum' : 1000000}))
425  call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
426	      \ 'E745:')
427  call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
428	      \ sign_getplaced('Xsign', {'id' : 44}))
429  call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
430	      \ 'E745:')
431
432  " Tests for sign_unplace()
433  call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
434  call assert_equal(0, sign_unplace('',
435	      \ {'id' : 20, 'buffer' : 'Xsign'}))
436  call assert_equal(-1, sign_unplace('',
437	      \ {'id' : 30, 'buffer' : 'Xsign'}))
438  call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
439  call assert_fails("call sign_unplace('',
440	      \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
441  call assert_fails("call sign_unplace('',
442	      \ {'id' : 20, 'buffer' : '&'})", 'E158:')
443  call assert_fails("call sign_unplace('g1',
444	      \ {'id' : 20, 'buffer' : 200})", 'E158:')
445  call assert_fails("call sign_unplace('g1', 'mySign')", 'E715:')
446
447  " Tests for sign_undefine()
448  call assert_equal(0, sign_undefine("sign1"))
449  call assert_equal([], sign_getdefined("sign1"))
450  call assert_fails('call sign_undefine("none")', 'E155:')
451  call assert_fails('call sign_undefine([])', 'E730:')
452
453  call delete("Xsign")
454  call sign_unplace('*')
455  call sign_undefine()
456  enew | only
457endfunc
458
459" Tests for sign groups
460func Test_sign_group()
461  enew | only
462  " Remove all the signs
463  call sign_unplace('*')
464  call sign_undefine()
465
466  call writefile(repeat(["Sun is shining"], 30), "Xsign")
467
468  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
469  call assert_equal(0, sign_define("sign1", attr))
470
471  edit Xsign
472  let bnum = bufnr('%')
473
474  " Error case
475  call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
476	      \ {'lnum' : 30})", 'E730:')
477
478  " place three signs with the same identifier. One in the global group and
479  " others in the named groups
480  call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
481	      \ {'lnum' : 10}))
482  call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
483  call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
484
485  " Test for sign_getplaced() with group
486  let s = sign_getplaced('Xsign')
487  call assert_equal(1, len(s[0].signs))
488  call assert_equal(s[0].signs[0].group, '')
489  let s = sign_getplaced(bnum, {'group' : ''})
490  call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
491	      \ 'priority' : 10}], s[0].signs)
492  call assert_equal(1, len(s[0].signs))
493  let s = sign_getplaced(bnum, {'group' : 'g2'})
494  call assert_equal('g2', s[0].signs[0].group)
495  let s = sign_getplaced(bnum, {'group' : 'g3'})
496  call assert_equal([], s[0].signs)
497  let s = sign_getplaced(bnum, {'group' : '*'})
498  call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
499	      \ 'priority' : 10},
500	      \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
501	      \  'priority' : 10},
502	      \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
503	      \  'priority' : 10}],
504	      \ s[0].signs)
505
506  " Test for sign_getplaced() with id
507  let s = sign_getplaced(bnum, {'id' : 5})
508  call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
509	      \ 'priority' : 10}],
510	      \ s[0].signs)
511  let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
512  call assert_equal(
513	      \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
514	      \ 'priority' : 10}],
515	      \ s[0].signs)
516  let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
517  call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
518	      \ 'priority' : 10},
519	      \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
520	      \ 'priority' : 10},
521	      \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
522	      \ 'priority' : 10}],
523	      \ s[0].signs)
524  let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
525  call assert_equal([], s[0].signs)
526
527  " Test for sign_getplaced() with lnum
528  let s = sign_getplaced(bnum, {'lnum' : 20})
529  call assert_equal([], s[0].signs)
530  let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
531  call assert_equal(
532	      \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
533	      \ 'priority' : 10}],
534	      \ s[0].signs)
535  let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
536  call assert_equal(
537	      \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
538	      \ 'priority' : 10}],
539	      \ s[0].signs)
540  let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
541  call assert_equal([], s[0].signs)
542
543  " Error case
544  call assert_fails("call sign_getplaced(bnum, {'group' : []})",
545	      \ 'E730:')
546
547  " Clear the sign in global group
548  call sign_unplace('', {'id' : 5, 'buffer' : bnum})
549  let s = sign_getplaced(bnum, {'group' : '*'})
550  call assert_equal([
551	      \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
552	      \ 'priority' : 10},
553	      \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
554	      \ 'priority' : 10}],
555	      \ s[0].signs)
556
557  " Clear the sign in one of the groups
558  call sign_unplace('g1', {'buffer' : 'Xsign'})
559  let s = sign_getplaced(bnum, {'group' : '*'})
560  call assert_equal([
561	      \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
562	      \ 'priority' : 10}],
563	      \ s[0].signs)
564
565  " Clear all the signs from the buffer
566  call sign_unplace('*', {'buffer' : bnum})
567  call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
568
569  " Clear sign across groups using an identifier
570  call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
571  call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
572  call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
573  call assert_equal(0, sign_unplace('*', {'id' : 25}))
574  call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
575
576  " Error case
577  call assert_fails("call sign_unplace([])", 'E474:')
578
579  " Place a sign in the global group and try to delete it using a group
580  call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
581  call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
582
583  " Place signs in multiple groups and delete all the signs in one of the
584  " group
585  call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
586  call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
587  call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
588  call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
589  call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
590  call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
591  call assert_equal(0, sign_unplace('g1'))
592  let s = sign_getplaced(bnum, {'group' : 'g1'})
593  call assert_equal([], s[0].signs)
594  let s = sign_getplaced(bnum)
595  call assert_equal(2, len(s[0].signs))
596  let s = sign_getplaced(bnum, {'group' : 'g2'})
597  call assert_equal('g2', s[0].signs[0].group)
598  call assert_equal(0, sign_unplace('', {'id' : 5}))
599  call assert_equal(0, sign_unplace('', {'id' : 6}))
600  let s = sign_getplaced(bnum, {'group' : 'g2'})
601  call assert_equal('g2', s[0].signs[0].group)
602  call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
603
604  call sign_unplace('*')
605
606  " Test for :sign command and groups
607  sign place 5 line=10 name=sign1 file=Xsign
608  sign place 5 group=g1 line=10 name=sign1 file=Xsign
609  sign place 5 group=g2 line=10 name=sign1 file=Xsign
610
611  " Tests for the ':sign place' command
612
613  " :sign place file={fname}
614  let a = execute('sign place file=Xsign')
615  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
616	      \ "    line=10  id=5  name=sign1  priority=10\n", a)
617
618  " :sign place group={group} file={fname}
619  let a = execute('sign place group=g2 file=Xsign')
620  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
621	      \ "    line=10  id=5  group=g2  name=sign1  priority=10\n", a)
622
623  " :sign place group=* file={fname}
624  let a = execute('sign place group=* file=Xsign')
625  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
626	      \ "    line=10  id=5  group=g2  name=sign1  priority=10\n" .
627	      \ "    line=10  id=5  group=g1  name=sign1  priority=10\n" .
628	      \ "    line=10  id=5  name=sign1  priority=10\n", a)
629
630  " Error case: non-existing group
631  let a = execute('sign place group=xyz file=Xsign')
632  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
633
634  call sign_unplace('*')
635  let bnum = bufnr('Xsign')
636  exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
637  exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
638  exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
639
640  " :sign place buffer={fname}
641  let a = execute('sign place buffer=' . bnum)
642  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
643	      \ "    line=10  id=5  name=sign1  priority=10\n", a)
644
645  " :sign place group={group} buffer={fname}
646  let a = execute('sign place group=g2 buffer=' . bnum)
647  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
648	      \ "    line=12  id=5  group=g2  name=sign1  priority=10\n", a)
649
650  " :sign place group=* buffer={fname}
651  let a = execute('sign place group=* buffer=' . bnum)
652  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
653	      \ "    line=10  id=5  name=sign1  priority=10\n" .
654	      \ "    line=11  id=5  group=g1  name=sign1  priority=10\n" .
655	      \ "    line=12  id=5  group=g2  name=sign1  priority=10\n", a)
656
657  " Error case: non-existing group
658  let a = execute('sign place group=xyz buffer=' . bnum)
659  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
660
661  " :sign place
662  let a = execute('sign place')
663  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
664	      \ "    line=10  id=5  name=sign1  priority=10\n", a)
665
666  " Place signs in more than one buffer and list the signs
667  split foo
668  set buftype=nofile
669  sign place 25 line=76 name=sign1 priority=99 file=foo
670  let a = execute('sign place')
671  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
672	      \ "    line=10  id=5  name=sign1  priority=10\n" .
673	      \ "Signs for foo:\n" .
674	      \ "    line=76  id=25  name=sign1  priority=99\n", a)
675  close
676  bwipe foo
677
678  " :sign place group={group}
679  let a = execute('sign place group=g1')
680  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
681	      \ "    line=11  id=5  group=g1  name=sign1  priority=10\n", a)
682
683  " :sign place group=*
684  let a = execute('sign place group=*')
685  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
686	      \ "    line=10  id=5  name=sign1  priority=10\n" .
687	      \ "    line=11  id=5  group=g1  name=sign1  priority=10\n" .
688	      \ "    line=12  id=5  group=g2  name=sign1  priority=10\n", a)
689
690  " Test for ':sign jump' command with groups
691  sign jump 5 group=g1 file=Xsign
692  call assert_equal(11, line('.'))
693  call assert_equal('Xsign', bufname(''))
694  sign jump 5 group=g2 file=Xsign
695  call assert_equal(12, line('.'))
696
697  " Test for :sign jump command without the filename or buffer
698  sign jump 5
699  call assert_equal(10, line('.'))
700  sign jump 5 group=g1
701  call assert_equal(11, line('.'))
702
703  " Error cases
704  call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
705
706  call delete("Xsign")
707  call sign_unplace('*')
708  call sign_undefine()
709  enew | only
710endfunc
711
712" Place signs used for ":sign unplace" command test
713func Place_signs_for_test()
714  call sign_unplace('*')
715
716  sign place 3 line=10 name=sign1 file=Xsign1
717  sign place 3 group=g1 line=11 name=sign1 file=Xsign1
718  sign place 3 group=g2 line=12 name=sign1 file=Xsign1
719  sign place 4 line=15 name=sign1 file=Xsign1
720  sign place 4 group=g1 line=16 name=sign1 file=Xsign1
721  sign place 4 group=g2 line=17 name=sign1 file=Xsign1
722  sign place 5 line=20 name=sign1 file=Xsign2
723  sign place 5 group=g1 line=21 name=sign1 file=Xsign2
724  sign place 5 group=g2 line=22 name=sign1 file=Xsign2
725  sign place 6 line=25 name=sign1 file=Xsign2
726  sign place 6 group=g1 line=26 name=sign1 file=Xsign2
727  sign place 6 group=g2 line=27 name=sign1 file=Xsign2
728endfunc
729
730" Place multiple signs in a single line for test
731func Place_signs_at_line_for_test()
732  call sign_unplace('*')
733  sign place 3 line=13 name=sign1 file=Xsign1
734  sign place 3 group=g1 line=13 name=sign1 file=Xsign1
735  sign place 3 group=g2 line=13 name=sign1 file=Xsign1
736  sign place 4 line=13 name=sign1 file=Xsign1
737  sign place 4 group=g1 line=13 name=sign1 file=Xsign1
738  sign place 4 group=g2 line=13 name=sign1 file=Xsign1
739endfunc
740
741" Tests for the ':sign unplace' command
742func Test_sign_unplace()
743  enew | only
744  " Remove all the signs
745  call sign_unplace('*')
746  call sign_undefine()
747
748  " Create two files and define signs
749  call writefile(repeat(["Sun is shining"], 30), "Xsign1")
750  call writefile(repeat(["It is beautiful"], 30), "Xsign2")
751
752  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
753  call sign_define("sign1", attr)
754
755  edit Xsign1
756  let bnum1 = bufnr('%')
757  split Xsign2
758  let bnum2 = bufnr('%')
759
760  let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
761	      \ 'priority' : 10},
762	      \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
763	      \ 'priority' : 10},
764	      \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
765	      \ 'priority' : 10},
766	      \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
767	      \ 'priority' : 10},
768	      \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
769	      \ 'priority' : 10},
770	      \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
771	      \ 'priority' : 10},]
772  let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
773	      \ 'priority' : 10},
774	      \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
775	      \ 'priority' : 10},
776	      \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
777	      \ 'priority' : 10},
778	      \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
779	      \ 'priority' : 10},
780	      \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
781	      \ 'priority' : 10},
782	      \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
783	      \ 'priority' : 10},]
784
785  " Test for :sign unplace {id} file={fname}
786  call Place_signs_for_test()
787  sign unplace 3 file=Xsign1
788  sign unplace 6 file=Xsign2
789  call assert_equal(
790	      \ filter(copy(signs1),
791	      \     {idx, val -> val.id != 3 || val.group != ''}),
792	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
793  call assert_equal(
794	      \ filter(copy(signs2),
795	      \     {idx, val -> val.id != 6 || val.group != ''}),
796	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
797
798  " Test for :sign unplace {id} group={group} file={fname}
799  call Place_signs_for_test()
800  sign unplace 4 group=g1 file=Xsign1
801  sign unplace 5 group=g2 file=Xsign2
802  call assert_equal(
803	      \ filter(copy(signs1),
804	      \     {idx, val -> val.id != 4 || val.group != 'g1'}),
805	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
806  call assert_equal(
807	      \ filter(copy(signs2),
808	      \     {idx, val -> val.id != 5 || val.group != 'g2'}),
809	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
810
811  " Test for :sign unplace {id} group=* file={fname}
812  call Place_signs_for_test()
813  sign unplace 3 group=* file=Xsign1
814  sign unplace 6 group=* file=Xsign2
815  call assert_equal(
816	      \ filter(copy(signs1),
817	      \     {idx, val -> val.id != 3}),
818	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
819  call assert_equal(
820	      \ filter(copy(signs2),
821	      \     {idx, val -> val.id != 6}),
822	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
823
824  " Test for :sign unplace * file={fname}
825  call Place_signs_for_test()
826  sign unplace * file=Xsign1
827  call assert_equal(
828	      \ filter(copy(signs1),
829	      \     {idx, val -> val.group != ''}),
830	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
831  call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
832
833  " Test for :sign unplace * group={group} file={fname}
834  call Place_signs_for_test()
835  sign unplace * group=g1 file=Xsign1
836  sign unplace * group=g2 file=Xsign2
837  call assert_equal(
838	      \ filter(copy(signs1),
839	      \     {idx, val -> val.group != 'g1'}),
840	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
841  call assert_equal(
842	      \ filter(copy(signs2),
843	      \     {idx, val -> val.group != 'g2'}),
844	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
845
846  " Test for :sign unplace * group=* file={fname}
847  call Place_signs_for_test()
848  sign unplace * group=* file=Xsign2
849  call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
850  call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
851
852  " Test for :sign unplace {id} buffer={nr}
853  call Place_signs_for_test()
854  exe 'sign unplace 3 buffer=' . bnum1
855  exe 'sign unplace 6 buffer=' . bnum2
856  call assert_equal(
857	      \ filter(copy(signs1),
858	      \     {idx, val -> val.id != 3 || val.group != ''}),
859	      \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
860  call assert_equal(
861	      \ filter(copy(signs2),
862	      \     {idx, val -> val.id != 6 || val.group != ''}),
863	      \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
864
865  " Test for :sign unplace {id} group={group} buffer={nr}
866  call Place_signs_for_test()
867  exe 'sign unplace 4 group=g1 buffer=' . bnum1
868  exe 'sign unplace 5 group=g2 buffer=' . bnum2
869  call assert_equal(
870	      \ filter(copy(signs1),
871	      \     {idx, val -> val.id != 4 || val.group != 'g1'}),
872	      \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
873  call assert_equal(
874	      \ filter(copy(signs2),
875	      \     {idx, val -> val.id != 5 || val.group != 'g2'}),
876	      \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
877
878  " Test for :sign unplace {id} group=* buffer={nr}
879  call Place_signs_for_test()
880  exe 'sign unplace 3 group=* buffer=' . bnum1
881  exe 'sign unplace 6 group=* buffer=' . bnum2
882  call assert_equal(
883	      \ filter(copy(signs1),
884	      \     {idx, val -> val.id != 3}),
885	      \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
886  call assert_equal(
887	      \ filter(copy(signs2),
888	      \     {idx, val -> val.id != 6}),
889	      \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
890
891  " Test for :sign unplace * buffer={nr}
892  call Place_signs_for_test()
893  exe 'sign unplace * buffer=' . bnum1
894  call assert_equal(
895	      \ filter(copy(signs1),
896	      \     {idx, val -> val.group != ''}),
897	      \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
898  call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
899
900  " Test for :sign unplace * group={group} buffer={nr}
901  call Place_signs_for_test()
902  exe 'sign unplace * group=g1 buffer=' . bnum1
903  exe 'sign unplace * group=g2 buffer=' . bnum2
904  call assert_equal(
905	      \ filter(copy(signs1),
906	      \     {idx, val -> val.group != 'g1'}),
907	      \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
908  call assert_equal(
909	      \ filter(copy(signs2),
910	      \     {idx, val -> val.group != 'g2'}),
911	      \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
912
913  " Test for :sign unplace * group=* buffer={nr}
914  call Place_signs_for_test()
915  exe 'sign unplace * group=* buffer=' . bnum2
916  call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
917  call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
918
919  " Test for :sign unplace {id}
920  call Place_signs_for_test()
921  sign unplace 4
922  sign unplace 6
923  call assert_equal(
924	      \ filter(copy(signs1),
925	      \     {idx, val -> val.id != 4 || val.group != ''}),
926	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
927  call assert_equal(
928	      \ filter(copy(signs2),
929	      \     {idx, val -> val.id != 6 || val.group != ''}),
930	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
931
932  " Test for :sign unplace {id} group={group}
933  call Place_signs_for_test()
934  sign unplace 4 group=g1
935  sign unplace 6 group=g2
936  call assert_equal(
937	      \ filter(copy(signs1),
938	      \     {idx, val -> val.id != 4 || val.group != 'g1'}),
939	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
940  call assert_equal(
941	      \ filter(copy(signs2),
942	      \     {idx, val -> val.id != 6 || val.group != 'g2'}),
943	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
944
945  " Test for :sign unplace {id} group=*
946  call Place_signs_for_test()
947  sign unplace 3 group=*
948  sign unplace 5 group=*
949  call assert_equal(
950	      \ filter(copy(signs1),
951	      \     {idx, val -> val.id != 3}),
952	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
953  call assert_equal(
954	      \ filter(copy(signs2),
955	      \     {idx, val -> val.id != 5}),
956	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
957
958  " Test for :sign unplace *
959  call Place_signs_for_test()
960  sign unplace *
961  call assert_equal(
962	      \ filter(copy(signs1),
963	      \     {idx, val -> val.group != ''}),
964	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
965  call assert_equal(
966	      \ filter(copy(signs2),
967	      \     {idx, val -> val.group != ''}),
968	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
969
970  " Test for :sign unplace * group={group}
971  call Place_signs_for_test()
972  sign unplace * group=g1
973  call assert_equal(
974	      \ filter(copy(signs1),
975	      \     {idx, val -> val.group != 'g1'}),
976	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
977  call assert_equal(
978	      \ filter(copy(signs2),
979	      \     {idx, val -> val.group != 'g1'}),
980	      \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
981
982  " Test for :sign unplace * group=*
983  call Place_signs_for_test()
984  sign unplace * group=*
985  call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
986  call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
987
988  " Negative test cases
989  call Place_signs_for_test()
990  sign unplace 3 group=xy file=Xsign1
991  sign unplace * group=xy file=Xsign1
992  silent! sign unplace * group=* file=FileNotPresent
993  call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
994  call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
995
996  " Tests for removing sign at the current cursor position
997
998  " Test for ':sign unplace'
999  let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1000	      \ 'priority' : 10},
1001	      \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1002	      \ 'priority' : 10},
1003	      \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1004	      \ 'priority' : 10},
1005	      \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1006	      \ 'priority' : 10},
1007	      \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1008	      \ 'priority' : 10},
1009	      \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1010	      \ 'priority' : 10},]
1011  exe bufwinnr('Xsign1') . 'wincmd w'
1012  call cursor(13, 1)
1013
1014  " Should remove only one sign in the global group
1015  call Place_signs_at_line_for_test()
1016  sign unplace
1017  call assert_equal(
1018	      \ filter(copy(signs1),
1019	      \     {idx, val -> val.id != 4 || val.group != ''}),
1020	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1021  " Should remove the second sign in the global group
1022  sign unplace
1023  call assert_equal(
1024	      \ filter(copy(signs1),
1025	      \     {idx, val -> val.group != ''}),
1026	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1027
1028  " Test for ':sign unplace group={group}'
1029  call Place_signs_at_line_for_test()
1030  " Should remove only one sign in group g1
1031  sign unplace group=g1
1032  call assert_equal(
1033	      \ filter(copy(signs1),
1034	      \     {idx, val -> val.id != 4 || val.group != 'g1'}),
1035	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1036  sign unplace group=g2
1037  call assert_equal(
1038	      \ filter(copy(signs1),
1039	      \     {idx, val -> val.id != 4 || val.group == ''}),
1040	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1041
1042  " Test for ':sign unplace group=*'
1043  call Place_signs_at_line_for_test()
1044  sign unplace group=*
1045  sign unplace group=*
1046  sign unplace group=*
1047  call assert_equal(
1048	      \ filter(copy(signs1),
1049	      \     {idx, val -> val.id != 4}),
1050	      \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1051  sign unplace group=*
1052  sign unplace group=*
1053  sign unplace group=*
1054  call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1055
1056  call sign_unplace('*')
1057  call sign_undefine()
1058  enew | only
1059  call delete("Xsign1")
1060  call delete("Xsign2")
1061endfunc
1062
1063" Tests for auto-generating the sign identifier
1064func Test_sign_id_autogen()
1065  enew | only
1066  call sign_unplace('*')
1067  call sign_undefine()
1068
1069  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1070  call assert_equal(0, sign_define("sign1", attr))
1071
1072  call writefile(repeat(["Sun is shining"], 30), "Xsign")
1073  edit Xsign
1074
1075  call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1076	      \ {'lnum' : 10}))
1077  call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1078	      \ {'lnum' : 12}))
1079  call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1080	      \ {'lnum' : 14}))
1081  call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
1082  call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
1083	      \ {'lnum' : 12}))
1084
1085  call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1086	      \ {'lnum' : 11}))
1087  " Check for the next generated sign id in this group
1088  call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1089	      \ {'lnum' : 12}))
1090  call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1091  call assert_equal(10,
1092	      \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1093
1094  call delete("Xsign")
1095  call sign_unplace('*')
1096  call sign_undefine()
1097  enew | only
1098endfunc
1099
1100" Test for sign priority
1101func Test_sign_priority()
1102  enew | only
1103  call sign_unplace('*')
1104  call sign_undefine()
1105
1106  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1107  call sign_define("sign1", attr)
1108  call sign_define("sign2", attr)
1109  call sign_define("sign3", attr)
1110
1111  " Place three signs with different priority in the same line
1112  call writefile(repeat(["Sun is shining"], 30), "Xsign")
1113  edit Xsign
1114
1115  call sign_place(1, 'g1', 'sign1', 'Xsign',
1116	      \ {'lnum' : 11, 'priority' : 50})
1117  call sign_place(2, 'g2', 'sign2', 'Xsign',
1118	      \ {'lnum' : 11, 'priority' : 100})
1119  call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1120  let s = sign_getplaced('Xsign', {'group' : '*'})
1121  call assert_equal([
1122	      \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1123	      \ 'priority' : 100},
1124	      \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1125	      \ 'priority' : 50},
1126	      \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1127	      \ 'priority' : 10}],
1128	      \ s[0].signs)
1129
1130  " Error case
1131  call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1132	      \ [])", 'E715:')
1133  call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1134	      \ {'priority' : []})", 'E745:')
1135  call sign_unplace('*')
1136
1137  " Tests for the :sign place command with priority
1138  sign place 5 line=10 name=sign1 priority=30 file=Xsign
1139  sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1140  sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1141  let a = execute('sign place group=*')
1142  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1143	      \ "    line=10  id=5  name=sign1  priority=30\n" .
1144	      \ "    line=10  id=5  group=g2  name=sign1  priority=25\n" .
1145	      \ "    line=10  id=5  group=g1  name=sign1  priority=20\n", a)
1146
1147  " Test for :sign place group={group}
1148  let a = execute('sign place group=g1')
1149  call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1150	      \ "    line=10  id=5  group=g1  name=sign1  priority=20\n", a)
1151
1152  call sign_unplace('*')
1153  call sign_undefine()
1154  enew | only
1155  call delete("Xsign")
1156endfunc
1157
1158" Tests for memory allocation failures in sign functions
1159func Test_sign_memfailures()
1160  call writefile(repeat(["Sun is shining"], 30), "Xsign")
1161  edit Xsign
1162
1163  call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1164  call assert_fails('call sign_getdefined("sign1")', 'E342:')
1165  call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1166  call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1167  call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1168  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1169  call assert_fails('call sign_define("sign1", attr)', 'E342:')
1170
1171  let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1172  call sign_define("sign1", attr)
1173  call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1174  call assert_fails('call sign_getdefined("sign1")', 'E342:')
1175
1176  call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1177  call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1178  call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1179  call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1180  call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1181
1182  call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1183  call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1184								\ 'E342:')
1185
1186  call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1187  call assert_fails('call getbufinfo()', 'E342:')
1188  call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1189  call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1190  call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1191  call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1192	      \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1193
1194  call sign_unplace('*')
1195  call sign_undefine()
1196  enew | only
1197  call delete("Xsign")
1198endfunc
1199
1200" Test for auto-adjusting the line number of a placed sign.
1201func Test_sign_lnum_adjust()
1202  enew! | only!
1203
1204  sign define sign1 text=#> linehl=Comment
1205  call setline(1, ['A', 'B', 'C', 'D', 'E'])
1206  exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1207  let l = sign_getplaced(bufnr(''))
1208  call assert_equal(3, l[0].signs[0].lnum)
1209
1210  " Add some lines before the sign and check the sign line number
1211  call append(2, ['BA', 'BB', 'BC'])
1212  let l = sign_getplaced(bufnr(''))
1213  call assert_equal(6, l[0].signs[0].lnum)
1214
1215  " Delete some lines before the sign and check the sign line number
1216  call deletebufline('%', 1, 2)
1217  let l = sign_getplaced(bufnr(''))
1218  call assert_equal(4, l[0].signs[0].lnum)
1219
1220  " Insert some lines after the sign and check the sign line number
1221  call append(5, ['DA', 'DB'])
1222  let l = sign_getplaced(bufnr(''))
1223  call assert_equal(4, l[0].signs[0].lnum)
1224
1225  " Delete some lines after the sign and check the sign line number
1226  call deletebufline('', 6, 7)
1227  let l = sign_getplaced(bufnr(''))
1228  call assert_equal(4, l[0].signs[0].lnum)
1229
1230  " Break the undo. Otherwise the undo operation below will undo all the
1231  " changes made by this function.
1232  let &undolevels=&undolevels
1233
1234  " Delete the line with the sign
1235  call deletebufline('', 4)
1236  let l = sign_getplaced(bufnr(''))
1237  call assert_equal(4, l[0].signs[0].lnum)
1238
1239  " Undo the delete operation
1240  undo
1241  let l = sign_getplaced(bufnr(''))
1242  call assert_equal(5, l[0].signs[0].lnum)
1243
1244  " Break the undo
1245  let &undolevels=&undolevels
1246
1247  " Delete few lines at the end of the buffer including the line with the sign
1248  " Sign line number should not change (as it is placed outside of the buffer)
1249  call deletebufline('', 3, 6)
1250  let l = sign_getplaced(bufnr(''))
1251  call assert_equal(5, l[0].signs[0].lnum)
1252
1253  " Undo the delete operation. Sign should be restored to the previous line
1254  undo
1255  let l = sign_getplaced(bufnr(''))
1256  call assert_equal(5, l[0].signs[0].lnum)
1257
1258  sign unplace * group=*
1259  sign undefine sign1
1260  enew!
1261endfunc
1262
1263" Test for changing the type of a placed sign
1264func Test_sign_change_type()
1265  enew! | only!
1266
1267  sign define sign1 text=#> linehl=Comment
1268  sign define sign2 text=@@ linehl=Comment
1269
1270  call setline(1, ['A', 'B', 'C', 'D'])
1271  exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1272  let l = sign_getplaced(bufnr(''))
1273  call assert_equal('sign1', l[0].signs[0].name)
1274  exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1275  let l = sign_getplaced(bufnr(''))
1276  call assert_equal('sign2', l[0].signs[0].name)
1277  call sign_place(4, '', 'sign1', '')
1278  let l = sign_getplaced(bufnr(''))
1279  call assert_equal('sign1', l[0].signs[0].name)
1280
1281  exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1282  let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1283  call assert_equal('sign1', l[0].signs[0].name)
1284  exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1285  let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1286  call assert_equal('sign2', l[0].signs[0].name)
1287  call sign_place(4, 'g1', 'sign1', '')
1288  let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1289  call assert_equal('sign1', l[0].signs[0].name)
1290
1291  sign unplace * group=*
1292  sign undefine sign1
1293  sign undefine sign2
1294  enew!
1295endfunc
1296
1297" Test for the sign_jump() function
1298func Test_sign_jump_func()
1299  enew! | only!
1300
1301  sign define sign1 text=#> linehl=Comment
1302
1303  edit foo
1304  set buftype=nofile
1305  call setline(1, ['A', 'B', 'C', 'D', 'E'])
1306  call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1307  call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1308  call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1309  call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1310  split bar
1311  set buftype=nofile
1312  call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1313  call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1314  call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1315  call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1316  call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1317
1318  let r = sign_jump(5, '', 'foo')
1319  call assert_equal(2, r)
1320  call assert_equal(2, line('.'))
1321  let r = sign_jump(6, 'g1', 'foo')
1322  call assert_equal(5, r)
1323  call assert_equal(5, line('.'))
1324  let r = sign_jump(5, '', 'bar')
1325  call assert_equal(2, r)
1326  call assert_equal(2, line('.'))
1327
1328  " Error cases
1329  call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1330  call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1331  call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1332  call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1333  call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
1334  call assert_fails('call sign_jump(2, "", {})', 'E158:')
1335  call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1336
1337  sign unplace * group=*
1338  sign undefine sign1
1339  enew! | only!
1340endfunc
1341