blob: 5bb0cf92632d4e611719ed8a0bf6466eb0b29b84 [file] [log] [blame]
Bram Moolenaar09de1752016-08-08 22:26:48 +02001" 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
Bram Moolenaar446a9732016-08-10 21:36:23 +020011 " 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.
Bram Moolenaar09de1752016-08-08 22:26:48 +020015 sign define Sign1 text=x
Bram Moolenaar446a9732016-08-10 21:36:23 +020016 try
Bram Moolenaarb328cca2019-01-06 16:24:01 +010017 sign define Sign2 text=xy texthl=Title linehl=Error
18 \ icon=../../pixmaps/stock_vim_find_help.png
Bram Moolenaar446a9732016-08-10 21:36:23 +020019 catch /E255:/
Bram Moolenaar162b7142018-12-21 15:17:36 +010020 " Ignore error: E255: Couldn't read in sign data!
21 " This error can happen when running in the GUI.
Bram Moolenaar446a9732016-08-10 21:36:23 +020022 " Some gui like Motif do not support the png icon format.
23 endtry
Bram Moolenaar09de1752016-08-08 22:26:48 +020024
25 " Test listing signs.
26 let a=execute('sign list')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010027 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)
Bram Moolenaar09de1752016-08-08 22:26:48 +020030
31 let a=execute('sign list Sign1')
32 call assert_equal("\nsign Sign1 text=x ", a)
33
Bram Moolenaar7d83bf42018-12-29 18:53:55 +010034 " Split the window to the bottom to verify sign jump will stay in the
35 " current window if the buffer is displayed there.
Bram Moolenaar446a9732016-08-10 21:36:23 +020036 let bn = bufnr('%')
37 let wn = winnr()
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010038 exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
Bram Moolenaar09de1752016-08-08 22:26:48 +020039 1
Bram Moolenaar446a9732016-08-10 21:36:23 +020040 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('%'))
Bram Moolenaar09de1752016-08-08 22:26:48 +020053 call assert_equal('c', getline('.'))
54
Bram Moolenaar446a9732016-08-10 21:36:23 +020055 " 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
Bram Moolenaar09de1752016-08-08 22:26:48 +020063
Bram Moolenaar446a9732016-08-10 21:36:23 +020064 " Check that we can't change sign.
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010065 call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
Bram Moolenaar446a9732016-08-10 21:36:23 +020066
67 " Check placed signs
Bram Moolenaar09de1752016-08-08 22:26:48 +020068 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010069 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
70 \ " line=3 id=41 name=Sign1 priority=10\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020071
Bram Moolenaar446a9732016-08-10 21:36:23 +020072 " Unplace the sign and try jumping to it again should fail.
73 sign unplace 41
Bram Moolenaar09de1752016-08-08 22:26:48 +020074 1
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010075 call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
Bram Moolenaar09de1752016-08-08 22:26:48 +020076 call assert_equal('a', getline('.'))
77
78 " Unplace sign on current line.
Bram Moolenaar446a9732016-08-10 21:36:23 +020079 exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020080 4
81 sign unplace
82 let a=execute('sign place')
83 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010084
Bram Moolenaar09de1752016-08-08 22:26:48 +020085 " 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.
Bram Moolenaar446a9732016-08-10 21:36:23 +020089 exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020090 sign unplace *
91 let a=execute('sign place')
92 call assert_equal("\n--- Signs ---\n", a)
93
Bram Moolenaarb328cca2019-01-06 16:24:01 +010094 " 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
Bram Moolenaar446a9732016-08-10 21:36:23 +0200101 " Check :jump with file=...
102 edit foo
103 call setline(1, ['A', 'B', 'C', 'D'])
104
105 try
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100106 sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist
107 \ icon=doesnotexist.xpm
Bram Moolenaar446a9732016-08-10 21:36:23 +0200108 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
Bram Moolenaara3556522018-12-31 22:02:29 +0100119 " 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
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100129 " 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:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100137 call assert_fails("sign define Sign4 text=\\ ab linehl=Comment", 'E239:')
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100138
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
Bram Moolenaara3556522018-12-31 22:02:29 +0100156 " 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')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100163 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
164 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100165 exe 'sign unplace 20 buffer=' . bufnr('')
166 sign undefine 004
167 call assert_fails('sign list 4', 'E155:')
168
Bram Moolenaar09de1752016-08-08 22:26:48 +0200169 " After undefining the sign, we should no longer be able to place it.
170 sign undefine Sign1
171 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200172 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100173 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
174 \ bufnr('%'), 'E155:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200175endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200176
Bram Moolenaar446a9732016-08-10 21:36:23 +0200177" 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')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100191 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
192 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200193
194 sign unplace 41
195 let a=execute('sign place')
196 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200197endfunc
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')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100210 call assert_equal('"sign define Sign linehl=SpellBad SpellCap ' .
211 \ 'SpellLocal SpellRare', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200212
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200213 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')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200219
Bram Moolenaar09de1752016-08-08 22:26:48 +0200220 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')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100224 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
225 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200226
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')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100231 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200232
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')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100237 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200238
239 sign undefine Sign1
240 sign undefine Sign2
Bram Moolenaar09de1752016-08-08 22:26:48 +0200241endfunc
242
243func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100244 sign define Sign1 text=x
245
Bram Moolenaar09de1752016-08-08 22:26:48 +0200246 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200247 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200248 call assert_fails('sign xxx', 'E160:')
249 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200250 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200251 call assert_fails('sign undefine', 'E156:')
252 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200253 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100254 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:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200262 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100263 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100264 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
265 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100266 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100267 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
268 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100269 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100270 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
271 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100272 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100273 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
274 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100275 " Sign identifier and '*' for :sign unplace
276 call assert_fails("sign unplace 2 *", 'E474:')
277 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100278 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
279 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100280 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100281 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
282 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100283 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
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100287 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100288 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100289 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100290 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100291 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100292 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100293 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100294 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100295 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100296 " 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:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100302 " 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:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100307
308 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200309endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200310
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
Bram Moolenaar162b7142018-12-21 15:17:36 +0100322
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100323" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100324func 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}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100377 \ sign_getplaced('%', {'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100378 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
379 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
380 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100381 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100382
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:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100398 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100399 \ '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:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100406 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
407 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100408 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:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100420 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100421 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('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100442 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100443 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100444 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100445 call assert_fails("call sign_unplace('g1', 'mySign')", 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100446
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('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100473
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, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100489 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))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100493 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
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100607 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
Bram Moolenaar162b7142018-12-21 15:17:36 +0100610
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100611 " Tests for the ':sign place' command
612
613 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100614 let a = execute('sign place file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100615 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
616 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100617
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100618 " :sign place group={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100619 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100620 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
621 \ " line=10 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100622
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100623 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100624 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100625 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
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100630 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100631 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100632 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
633
634 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100635 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
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100640 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100641 let a = execute('sign place buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100642 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
643 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100644
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100645 " :sign place group={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100646 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100647 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
648 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100649
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100650 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100651 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
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100657 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100658 let a = execute('sign place group=xyz buffer=' . bnum)
659 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
660
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100661 " :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 " :sign place group={group}
667 let a = execute('sign place group=g1')
668 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
669 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
670
671 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100672 let a = execute('sign place group=*')
673 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
674 \ " line=10 id=5 name=sign1 priority=10\n" .
675 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
676 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
677
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100678 " Test for ':sign jump' command with groups
679 sign jump 5 group=g1 file=Xsign
680 call assert_equal(11, line('.'))
681 call assert_equal('Xsign', bufname(''))
682 sign jump 5 group=g2 file=Xsign
683 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100684
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100685 " Test for :sign jump command without the filename or buffer
686 sign jump 5
687 call assert_equal(10, line('.'))
688 sign jump 5 group=g1
689 call assert_equal(11, line('.'))
690
Bram Moolenaar162b7142018-12-21 15:17:36 +0100691 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100692 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100693
694 call delete("Xsign")
695 call sign_unplace('*')
696 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100697 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100698endfunc
699
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100700" Place signs used for ":sign unplace" command test
701func Place_signs_for_test()
702 call sign_unplace('*')
703
704 sign place 3 line=10 name=sign1 file=Xsign1
705 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
706 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
707 sign place 4 line=15 name=sign1 file=Xsign1
708 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
709 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
710 sign place 5 line=20 name=sign1 file=Xsign2
711 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
712 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
713 sign place 6 line=25 name=sign1 file=Xsign2
714 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
715 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
716endfunc
717
718" Place multiple signs in a single line for test
719func Place_signs_at_line_for_test()
720 call sign_unplace('*')
721 sign place 3 line=13 name=sign1 file=Xsign1
722 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
723 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
724 sign place 4 line=13 name=sign1 file=Xsign1
725 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
726 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
727endfunc
728
729" Tests for the ':sign unplace' command
730func Test_sign_unplace()
731 enew | only
732 " Remove all the signs
733 call sign_unplace('*')
734 call sign_undefine()
735
736 " Create two files and define signs
737 call writefile(repeat(["Sun is shining"], 30), "Xsign1")
738 call writefile(repeat(["It is beautiful"], 30), "Xsign2")
739
740 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
741 call sign_define("sign1", attr)
742
743 edit Xsign1
744 let bnum1 = bufnr('%')
745 split Xsign2
746 let bnum2 = bufnr('%')
747
748 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
749 \ 'priority' : 10},
750 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
751 \ 'priority' : 10},
752 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
753 \ 'priority' : 10},
754 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
755 \ 'priority' : 10},
756 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
757 \ 'priority' : 10},
758 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
759 \ 'priority' : 10},]
760 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
761 \ 'priority' : 10},
762 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
763 \ 'priority' : 10},
764 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
765 \ 'priority' : 10},
766 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
767 \ 'priority' : 10},
768 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
769 \ 'priority' : 10},
770 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
771 \ 'priority' : 10},]
772
773 " Test for :sign unplace {id} file={fname}
774 call Place_signs_for_test()
775 sign unplace 3 file=Xsign1
776 sign unplace 6 file=Xsign2
777 call assert_equal(
778 \ filter(copy(signs1),
779 \ {idx, val -> val.id != 3 || val.group != ''}),
780 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
781 call assert_equal(
782 \ filter(copy(signs2),
783 \ {idx, val -> val.id != 6 || val.group != ''}),
784 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
785
786 " Test for :sign unplace {id} group={group} file={fname}
787 call Place_signs_for_test()
788 sign unplace 4 group=g1 file=Xsign1
789 sign unplace 5 group=g2 file=Xsign2
790 call assert_equal(
791 \ filter(copy(signs1),
792 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
793 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
794 call assert_equal(
795 \ filter(copy(signs2),
796 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
797 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
798
799 " Test for :sign unplace {id} group=* file={fname}
800 call Place_signs_for_test()
801 sign unplace 3 group=* file=Xsign1
802 sign unplace 6 group=* file=Xsign2
803 call assert_equal(
804 \ filter(copy(signs1),
805 \ {idx, val -> val.id != 3}),
806 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
807 call assert_equal(
808 \ filter(copy(signs2),
809 \ {idx, val -> val.id != 6}),
810 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
811
812 " Test for :sign unplace * file={fname}
813 call Place_signs_for_test()
814 sign unplace * file=Xsign1
815 call assert_equal(
816 \ filter(copy(signs1),
817 \ {idx, val -> val.group != ''}),
818 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
819 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
820
821 " Test for :sign unplace * group={group} file={fname}
822 call Place_signs_for_test()
823 sign unplace * group=g1 file=Xsign1
824 sign unplace * group=g2 file=Xsign2
825 call assert_equal(
826 \ filter(copy(signs1),
827 \ {idx, val -> val.group != 'g1'}),
828 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
829 call assert_equal(
830 \ filter(copy(signs2),
831 \ {idx, val -> val.group != 'g2'}),
832 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
833
834 " Test for :sign unplace * group=* file={fname}
835 call Place_signs_for_test()
836 sign unplace * group=* file=Xsign2
837 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
838 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
839
840 " Test for :sign unplace {id} buffer={nr}
841 call Place_signs_for_test()
842 exe 'sign unplace 3 buffer=' . bnum1
843 exe 'sign unplace 6 buffer=' . bnum2
844 call assert_equal(
845 \ filter(copy(signs1),
846 \ {idx, val -> val.id != 3 || val.group != ''}),
847 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
848 call assert_equal(
849 \ filter(copy(signs2),
850 \ {idx, val -> val.id != 6 || val.group != ''}),
851 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
852
853 " Test for :sign unplace {id} group={group} buffer={nr}
854 call Place_signs_for_test()
855 exe 'sign unplace 4 group=g1 buffer=' . bnum1
856 exe 'sign unplace 5 group=g2 buffer=' . bnum2
857 call assert_equal(
858 \ filter(copy(signs1),
859 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
860 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
861 call assert_equal(
862 \ filter(copy(signs2),
863 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
864 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
865
866 " Test for :sign unplace {id} group=* buffer={nr}
867 call Place_signs_for_test()
868 exe 'sign unplace 3 group=* buffer=' . bnum1
869 exe 'sign unplace 6 group=* buffer=' . bnum2
870 call assert_equal(
871 \ filter(copy(signs1),
872 \ {idx, val -> val.id != 3}),
873 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
874 call assert_equal(
875 \ filter(copy(signs2),
876 \ {idx, val -> val.id != 6}),
877 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
878
879 " Test for :sign unplace * buffer={nr}
880 call Place_signs_for_test()
881 exe 'sign unplace * buffer=' . bnum1
882 call assert_equal(
883 \ filter(copy(signs1),
884 \ {idx, val -> val.group != ''}),
885 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
886 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
887
888 " Test for :sign unplace * group={group} buffer={nr}
889 call Place_signs_for_test()
890 exe 'sign unplace * group=g1 buffer=' . bnum1
891 exe 'sign unplace * group=g2 buffer=' . bnum2
892 call assert_equal(
893 \ filter(copy(signs1),
894 \ {idx, val -> val.group != 'g1'}),
895 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
896 call assert_equal(
897 \ filter(copy(signs2),
898 \ {idx, val -> val.group != 'g2'}),
899 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
900
901 " Test for :sign unplace * group=* buffer={nr}
902 call Place_signs_for_test()
903 exe 'sign unplace * group=* buffer=' . bnum2
904 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
905 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
906
907 " Test for :sign unplace {id}
908 call Place_signs_for_test()
909 sign unplace 4
910 sign unplace 6
911 call assert_equal(
912 \ filter(copy(signs1),
913 \ {idx, val -> val.id != 4 || val.group != ''}),
914 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
915 call assert_equal(
916 \ filter(copy(signs2),
917 \ {idx, val -> val.id != 6 || val.group != ''}),
918 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
919
920 " Test for :sign unplace {id} group={group}
921 call Place_signs_for_test()
922 sign unplace 4 group=g1
923 sign unplace 6 group=g2
924 call assert_equal(
925 \ filter(copy(signs1),
926 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
927 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
928 call assert_equal(
929 \ filter(copy(signs2),
930 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
931 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
932
933 " Test for :sign unplace {id} group=*
934 call Place_signs_for_test()
935 sign unplace 3 group=*
936 sign unplace 5 group=*
937 call assert_equal(
938 \ filter(copy(signs1),
939 \ {idx, val -> val.id != 3}),
940 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
941 call assert_equal(
942 \ filter(copy(signs2),
943 \ {idx, val -> val.id != 5}),
944 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
945
946 " Test for :sign unplace *
947 call Place_signs_for_test()
948 sign unplace *
949 call assert_equal(
950 \ filter(copy(signs1),
951 \ {idx, val -> val.group != ''}),
952 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
953 call assert_equal(
954 \ filter(copy(signs2),
955 \ {idx, val -> val.group != ''}),
956 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
957
958 " Test for :sign unplace * group={group}
959 call Place_signs_for_test()
960 sign unplace * group=g1
961 call assert_equal(
962 \ filter(copy(signs1),
963 \ {idx, val -> val.group != 'g1'}),
964 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
965 call assert_equal(
966 \ filter(copy(signs2),
967 \ {idx, val -> val.group != 'g1'}),
968 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
969
970 " Test for :sign unplace * group=*
971 call Place_signs_for_test()
972 sign unplace * group=*
973 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
974 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
975
976 " Negative test cases
977 call Place_signs_for_test()
978 sign unplace 3 group=xy file=Xsign1
979 sign unplace * group=xy file=Xsign1
980 silent! sign unplace * group=* file=FileNotPresent
981 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
982 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
983
984 " Tests for removing sign at the current cursor position
985
986 " Test for ':sign unplace'
987 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
988 \ 'priority' : 10},
989 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
990 \ 'priority' : 10},
991 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
992 \ 'priority' : 10},
993 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
994 \ 'priority' : 10},
995 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
996 \ 'priority' : 10},
997 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
998 \ 'priority' : 10},]
999 exe bufwinnr('Xsign1') . 'wincmd w'
1000 call cursor(13, 1)
1001
1002 " Should remove only one sign in the global group
1003 call Place_signs_at_line_for_test()
1004 sign unplace
1005 call assert_equal(
1006 \ filter(copy(signs1),
1007 \ {idx, val -> val.id != 4 || val.group != ''}),
1008 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1009 " Should remove the second sign in the global group
1010 sign unplace
1011 call assert_equal(
1012 \ filter(copy(signs1),
1013 \ {idx, val -> val.group != ''}),
1014 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1015
1016 " Test for ':sign unplace group={group}'
1017 call Place_signs_at_line_for_test()
1018 " Should remove only one sign in group g1
1019 sign unplace group=g1
1020 call assert_equal(
1021 \ filter(copy(signs1),
1022 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1023 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1024 sign unplace group=g2
1025 call assert_equal(
1026 \ filter(copy(signs1),
1027 \ {idx, val -> val.id != 4 || val.group == ''}),
1028 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1029
1030 " Test for ':sign unplace group=*'
1031 call Place_signs_at_line_for_test()
1032 sign unplace group=*
1033 sign unplace group=*
1034 sign unplace group=*
1035 call assert_equal(
1036 \ filter(copy(signs1),
1037 \ {idx, val -> val.id != 4}),
1038 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1039 sign unplace group=*
1040 sign unplace group=*
1041 sign unplace group=*
1042 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1043
1044 call sign_unplace('*')
1045 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001046 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001047 call delete("Xsign1")
1048 call delete("Xsign2")
1049endfunc
1050
Bram Moolenaar162b7142018-12-21 15:17:36 +01001051" Tests for auto-generating the sign identifier
1052func Test_sign_id_autogen()
1053 enew | only
1054 call sign_unplace('*')
1055 call sign_undefine()
1056
1057 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1058 call assert_equal(0, sign_define("sign1", attr))
1059
1060 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1061 edit Xsign
1062
1063 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1064 \ {'lnum' : 10}))
1065 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1066 \ {'lnum' : 12}))
1067 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1068 \ {'lnum' : 14}))
1069 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001070 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001071 \ {'lnum' : 12}))
1072
1073 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1074 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001075 " Check for the next generated sign id in this group
1076 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1077 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001078 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1079 call assert_equal(10,
1080 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1081
1082 call delete("Xsign")
1083 call sign_unplace('*')
1084 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001085 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001086endfunc
1087
1088" Test for sign priority
1089func Test_sign_priority()
1090 enew | only
1091 call sign_unplace('*')
1092 call sign_undefine()
1093
1094 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1095 call sign_define("sign1", attr)
1096 call sign_define("sign2", attr)
1097 call sign_define("sign3", attr)
1098
1099 " Place three signs with different priority in the same line
1100 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1101 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001102
1103 call sign_place(1, 'g1', 'sign1', 'Xsign',
1104 \ {'lnum' : 11, 'priority' : 50})
1105 call sign_place(2, 'g2', 'sign2', 'Xsign',
1106 \ {'lnum' : 11, 'priority' : 100})
1107 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1108 let s = sign_getplaced('Xsign', {'group' : '*'})
1109 call assert_equal([
1110 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1111 \ 'priority' : 100},
1112 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1113 \ 'priority' : 50},
1114 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1115 \ 'priority' : 10}],
1116 \ s[0].signs)
1117
1118 " Error case
1119 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1120 \ [])", 'E715:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001121 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1122 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001123 call sign_unplace('*')
1124
1125 " Tests for the :sign place command with priority
1126 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1127 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1128 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1129 let a = execute('sign place group=*')
1130 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1131 \ " line=10 id=5 name=sign1 priority=30\n" .
1132 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1133 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
1134
1135 " Test for :sign place group={group}
1136 let a = execute('sign place group=g1')
1137 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1138 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
1139
1140 call sign_unplace('*')
1141 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001142 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001143 call delete("Xsign")
1144endfunc
1145
1146" Tests for memory allocation failures in sign functions
1147func Test_sign_memfailures()
1148 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1149 edit Xsign
1150
1151 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1152 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1153 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1154 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1155 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1156 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1157 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1158
1159 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1160 call sign_define("sign1", attr)
1161 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1162 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1163
1164 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1165 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1166 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1167 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1168 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1169
1170 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1171 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1172 \ 'E342:')
1173
1174 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1175 call assert_fails('call getbufinfo()', 'E342:')
1176 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1177 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1178 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1179 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1180 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1181
1182 call sign_unplace('*')
1183 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001184 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001185 call delete("Xsign")
1186endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001187
1188" Test for auto-adjusting the line number of a placed sign.
1189func Test_sign_lnum_adjust()
1190 enew! | only!
1191
1192 sign define sign1 text=#> linehl=Comment
1193 call setline(1, ['A', 'B', 'C', 'D'])
1194 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1195 let l = sign_getplaced(bufnr(''))
1196 call assert_equal(3, l[0].signs[0].lnum)
1197
1198 " Add some lines before the sign and check the sign line number
1199 call append(2, ['AA', 'AB', 'AC'])
1200 let l = sign_getplaced(bufnr(''))
1201 call assert_equal(6, l[0].signs[0].lnum)
1202
1203 " Delete some lines before the sign and check the sign line number
1204 call deletebufline('%', 1, 2)
1205 let l = sign_getplaced(bufnr(''))
1206 call assert_equal(4, l[0].signs[0].lnum)
1207
1208 sign unplace * group=*
1209 sign undefine sign1
1210 enew!
1211endfunc
1212
1213" Test for changing the type of a placed sign
1214func Test_sign_change_type()
1215 enew! | only!
1216
1217 sign define sign1 text=#> linehl=Comment
1218 sign define sign2 text=@@ linehl=Comment
1219
1220 call setline(1, ['A', 'B', 'C', 'D'])
1221 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1222 let l = sign_getplaced(bufnr(''))
1223 call assert_equal('sign1', l[0].signs[0].name)
1224 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1225 let l = sign_getplaced(bufnr(''))
1226 call assert_equal('sign2', l[0].signs[0].name)
1227 call sign_place(4, '', 'sign1', '')
1228 let l = sign_getplaced(bufnr(''))
1229 call assert_equal('sign1', l[0].signs[0].name)
1230
1231 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1232 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1233 call assert_equal('sign1', l[0].signs[0].name)
1234 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1235 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1236 call assert_equal('sign2', l[0].signs[0].name)
1237 call sign_place(4, 'g1', 'sign1', '')
1238 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1239 call assert_equal('sign1', l[0].signs[0].name)
1240
1241 sign unplace * group=*
1242 sign undefine sign1
1243 sign undefine sign2
1244 enew!
1245endfunc