blob: 76cefa21c4eb979e7f6f744f0cc333b4c58b1d6f [file] [log] [blame]
Bram Moolenaar09de1752016-08-08 22:26:48 +02001" Test for signs
2
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02003source check.vim
4CheckFeature signs
Bram Moolenaar09de1752016-08-08 22:26:48 +02005
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02006source screendump.vim
7
Bram Moolenaar09de1752016-08-08 22:26:48 +02008func Test_sign()
9 new
10 call setline(1, ['a', 'b', 'c', 'd'])
11
Bram Moolenaar446a9732016-08-10 21:36:23 +020012 " Define some signs.
13 " We can specify icons even if not all versions of vim support icons as
14 " icon is ignored when not supported. "(not supported)" is shown after
15 " the icon name when listing signs.
Bram Moolenaar09de1752016-08-08 22:26:48 +020016 sign define Sign1 text=x
Bram Moolenaard933c822019-08-21 13:45:16 +020017
James McCoya80aad72021-12-22 19:45:28 +000018 call Sign_command_ignore_error('sign define Sign2 text=xy texthl=Title linehl=Error culhl=Search numhl=Number icon=../../pixmaps/stock_vim_find_help.png')
Bram Moolenaar09de1752016-08-08 22:26:48 +020019
20 " Test listing signs.
21 let a=execute('sign list')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010022 call assert_match('^\nsign Sign1 text=x \nsign Sign2 ' .
23 \ 'icon=../../pixmaps/stock_vim_find_help.png .*text=xy ' .
James McCoya80aad72021-12-22 19:45:28 +000024 \ 'linehl=Error texthl=Title culhl=Search numhl=Number$', a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020025
26 let a=execute('sign list Sign1')
27 call assert_equal("\nsign Sign1 text=x ", a)
28
Bram Moolenaar7d83bf42018-12-29 18:53:55 +010029 " Split the window to the bottom to verify sign jump will stay in the
30 " current window if the buffer is displayed there.
Bram Moolenaar446a9732016-08-10 21:36:23 +020031 let bn = bufnr('%')
32 let wn = winnr()
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010033 exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
Bram Moolenaar09de1752016-08-08 22:26:48 +020034 1
Bram Moolenaar446a9732016-08-10 21:36:23 +020035 bot split
36 exe 'sign jump 41 buffer=' . bufnr('%')
37 call assert_equal('c', getline('.'))
38 call assert_equal(3, winnr())
39 call assert_equal(bn, bufnr('%'))
40 call assert_notequal(wn, winnr())
41
42 " Create a new buffer and check that ":sign jump" switches to the old buffer.
43 1
44 new foo
45 call assert_notequal(bn, bufnr('%'))
46 exe 'sign jump 41 buffer=' . bn
47 call assert_equal(bn, bufnr('%'))
Bram Moolenaar09de1752016-08-08 22:26:48 +020048 call assert_equal('c', getline('.'))
49
Bram Moolenaar446a9732016-08-10 21:36:23 +020050 " Redraw to make sure that screen redraw with sign gets exercised,
51 " with and without 'rightleft'.
52 if has('rightleft')
53 set rightleft
54 redraw
55 set norightleft
56 endif
57 redraw
Bram Moolenaar09de1752016-08-08 22:26:48 +020058
Bram Moolenaar446a9732016-08-10 21:36:23 +020059 " Check that we can't change sign.
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010060 call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
Bram Moolenaar446a9732016-08-10 21:36:23 +020061
62 " Check placed signs
Bram Moolenaar09de1752016-08-08 22:26:48 +020063 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010064 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010065 \ " line=3 id=41 name=Sign1 priority=10\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020066
Bram Moolenaar446a9732016-08-10 21:36:23 +020067 " Unplace the sign and try jumping to it again should fail.
68 sign unplace 41
Bram Moolenaar09de1752016-08-08 22:26:48 +020069 1
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010070 call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
Bram Moolenaar09de1752016-08-08 22:26:48 +020071 call assert_equal('a', getline('.'))
72
73 " Unplace sign on current line.
Bram Moolenaar446a9732016-08-10 21:36:23 +020074 exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020075 4
76 sign unplace
77 let a=execute('sign place')
78 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010079
Bram Moolenaar09de1752016-08-08 22:26:48 +020080 " Try again to unplace sign on current line, it should fail this time.
81 call assert_fails('sign unplace', 'E159:')
82
83 " Unplace all signs.
Bram Moolenaar446a9732016-08-10 21:36:23 +020084 exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020085 sign unplace *
86 let a=execute('sign place')
87 call assert_equal("\n--- Signs ---\n", a)
88
Bram Moolenaarb328cca2019-01-06 16:24:01 +010089 " Place a sign without specifying the filename or buffer
90 sign place 77 line=9 name=Sign2
91 let a=execute('sign place')
92 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010093 \ " line=9 id=77 name=Sign2 priority=10\n", a)
Bram Moolenaarb328cca2019-01-06 16:24:01 +010094 sign unplace *
95
Bram Moolenaar446a9732016-08-10 21:36:23 +020096 " Check :jump with file=...
97 edit foo
98 call setline(1, ['A', 'B', 'C', 'D'])
99
Bram Moolenaard933c822019-08-21 13:45:16 +0200100 call Sign_command_ignore_error('sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist icon=doesnotexist.xpm')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200101
102 let fn = expand('%:p')
103 exe 'sign place 43 line=2 name=Sign3 file=' . fn
104 edit bar
105 call assert_notequal(fn, expand('%:p'))
106 exe 'sign jump 43 file=' . fn
107 call assert_equal('B', getline('.'))
108
Bram Moolenaara3556522018-12-31 22:02:29 +0100109 " Check for jumping to a sign in a hidden buffer
110 enew! | only!
111 edit foo
112 call setline(1, ['A', 'B', 'C', 'D'])
113 let fn = expand('%:p')
114 exe 'sign place 21 line=3 name=Sign3 file=' . fn
115 hide edit bar
116 exe 'sign jump 21 file=' . fn
117 call assert_equal('C', getline('.'))
118
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100119 " can't define a sign with a non-printable character as text
120 call assert_fails("sign define Sign4 text=\e linehl=Comment", 'E239:')
121 call assert_fails("sign define Sign4 text=a\e linehl=Comment", 'E239:')
122 call assert_fails("sign define Sign4 text=\ea linehl=Comment", 'E239:')
123
124 " Only 1 or 2 character text is allowed
125 call assert_fails("sign define Sign4 text=abc linehl=Comment", 'E239:')
126 call assert_fails("sign define Sign4 text= linehl=Comment", 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100127 call assert_fails("sign define Sign4 text=\\ ab linehl=Comment", 'E239:')
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100128
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000129 " an empty highlight argument for an existing sign clears it
James McCoya80aad72021-12-22 19:45:28 +0000130 sign define SignY texthl=TextHl culhl=CulHl linehl=LineHl numhl=NumHl
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000131 let sl = sign_getdefined('SignY')[0]
132 call assert_equal('TextHl', sl.texthl)
133 call assert_equal('CulHl', sl.culhl)
134 call assert_equal('LineHl', sl.linehl)
James McCoya80aad72021-12-22 19:45:28 +0000135 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000136
James McCoya80aad72021-12-22 19:45:28 +0000137 sign define SignY texthl= culhl=CulHl linehl=LineHl numhl=NumHl
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000138 let sl = sign_getdefined('SignY')[0]
139 call assert_false(has_key(sl, 'texthl'))
140 call assert_equal('CulHl', sl.culhl)
141 call assert_equal('LineHl', sl.linehl)
James McCoya80aad72021-12-22 19:45:28 +0000142 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000143
144 sign define SignY linehl=
145 let sl = sign_getdefined('SignY')[0]
146 call assert_false(has_key(sl, 'linehl'))
147 call assert_equal('CulHl', sl.culhl)
James McCoya80aad72021-12-22 19:45:28 +0000148 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000149
150 sign define SignY culhl=
151 let sl = sign_getdefined('SignY')[0]
152 call assert_false(has_key(sl, 'culhl'))
James McCoya80aad72021-12-22 19:45:28 +0000153 call assert_equal('NumHl', sl.numhl)
154
155 sign define SignY numhl=
156 let sl = sign_getdefined('SignY')[0]
157 call assert_false(has_key(sl, 'numhl'))
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000158
159 sign undefine SignY
Bram Moolenaar5e18ccc2021-12-05 13:02:50 +0000160
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100161 " define sign with whitespace
162 sign define Sign4 text=\ X linehl=Comment
163 sign undefine Sign4
164 sign define Sign4 linehl=Comment text=\ X
165 sign undefine Sign4
166
167 sign define Sign5 text=X\ linehl=Comment
168 sign undefine Sign5
169 sign define Sign5 linehl=Comment text=X\
170 sign undefine Sign5
171
172 " define sign with backslash
173 sign define Sign4 text=\\\\ linehl=Comment
174 sign undefine Sign4
175 sign define Sign4 text=\\ linehl=Comment
176 sign undefine Sign4
177
Bram Moolenaara3556522018-12-31 22:02:29 +0100178 " define a sign with a leading 0 in the name
179 sign unplace *
180 sign define 004 text=#> linehl=Comment
181 let a = execute('sign list 4')
182 call assert_equal("\nsign 4 text=#> linehl=Comment", a)
183 exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
184 let a = execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100185 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100186 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100187 exe 'sign unplace 20 buffer=' . bufnr('')
188 sign undefine 004
189 call assert_fails('sign list 4', 'E155:')
190
Bram Moolenaar09de1752016-08-08 22:26:48 +0200191 " After undefining the sign, we should no longer be able to place it.
192 sign undefine Sign1
193 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200194 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100195 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
196 \ bufnr('%'), 'E155:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200197endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200198
Bram Moolenaar2b1ddf12022-09-21 11:21:57 +0100199func Test_sign_many_bytes()
200 new
201 set signcolumn=number
202 set number
203 call setline(1, 'some text')
204 " composing characters can use many bytes, check for overflow
205 sign define manyBytes text=▶᷄᷅᷆◀᷄᷅᷆᷇
206 sign place 17 line=1 name=manyBytes
207 redraw
208
209 bwipe!
210 sign undefine manyBytes
211endfunc
212
Bram Moolenaar446a9732016-08-10 21:36:23 +0200213" Undefining placed sign is not recommended.
214" Quoting :help sign
215"
216" :sign undefine {name}
217" Deletes a previously defined sign. If signs with this {name}
218" are still placed this will cause trouble.
219func Test_sign_undefine_still_placed()
220 new foobar
221 sign define Sign text=x
222 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
223 sign undefine Sign
224
225 " Listing placed sign should show that sign is deleted.
226 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100227 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100228 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200229
230 sign unplace 41
231 let a=execute('sign place')
232 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200233endfunc
234
235func Test_sign_completion()
236 sign define Sign1 text=x
237 sign define Sign2 text=y
238
239 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
240 call assert_equal('"sign define jump list place undefine unplace', @:)
241
242 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
James McCoya80aad72021-12-22 19:45:28 +0000243 call assert_equal('"sign define Sign culhl= icon= linehl= numhl= text= texthl=', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200244
James McCoya80aad72021-12-22 19:45:28 +0000245 for hl in ['culhl', 'linehl', 'numhl', 'texthl']
246 call feedkeys(":sign define Sign "..hl.."=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
247 call assert_equal('"sign define Sign '..hl..'=SpellBad SpellCap ' .
248 \ 'SpellLocal SpellRare', @:)
249 endfor
Bram Moolenaar3678f652019-02-17 14:50:25 +0100250
Bram Moolenaar56564962022-10-10 22:39:42 +0100251 call writefile(repeat(["Sun is shining"], 30), "XsignOne", 'D')
252 call writefile(repeat(["Sky is blue"], 30), "XsignTwo", 'D')
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200253 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
254 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200255
Bram Moolenaar3678f652019-02-17 14:50:25 +0100256 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200257 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
258 call assert_equal('"sign undefine Sign1 Sign2', @:)
259
260 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100261 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
262 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200263
264 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
265 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
266
Bram Moolenaar3678f652019-02-17 14:50:25 +0100267 edit XsignOne
268 sign place 1 name=Sign1 line=5
269 sign place 1 name=Sign1 group=g1 line=10
270 edit XsignTwo
271 sign place 1 name=Sign2 group=g2 line=15
272
273 " Test for completion of group= and file= arguments to ':sign place'
274 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
275 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
276 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
277 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
278
279 " Test for completion of arguments to 'sign place' without sign identifier
280 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
281 call assert_equal('"sign place buffer= file= group=', @:)
282 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
283 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
284 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
285 call assert_equal('"sign place group=g1 g2', @:)
286 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
287 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
288
289 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200290 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100291 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100292 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
293 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
294 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
295 call assert_equal('"sign unplace 1 group=g1 g2', @:)
296 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
297 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200298
Bram Moolenaar3678f652019-02-17 14:50:25 +0100299 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200300 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
301 call assert_equal('"sign list Sign1 Sign2', @:)
302
Bram Moolenaar3678f652019-02-17 14:50:25 +0100303 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200304 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100305 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100306 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
307 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
308 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
309 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200310
Bram Moolenaar3678f652019-02-17 14:50:25 +0100311 " Error cases
312 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
313 call assert_equal('"sign here', @:)
314 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
315 call assert_equal("\"sign define Sign here=\<C-A>", @:)
316 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
317 call assert_equal("\"sign place 1 here=\<C-A>", @:)
318 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
319 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
320 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
321 call assert_equal("\"sign here there\<C-A>", @:)
322 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
323 call assert_equal("\"sign here there=\<C-A>", @:)
324
325 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200326 sign undefine Sign1
327 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100328 enew
Bram Moolenaar09de1752016-08-08 22:26:48 +0200329endfunc
330
331func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100332 sign define Sign1 text=x
333
Bram Moolenaar09de1752016-08-08 22:26:48 +0200334 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200335 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200336 call assert_fails('sign xxx', 'E160:')
337 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200338 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200339 call assert_fails('sign undefine', 'E156:')
340 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200341 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100342 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
343 call assert_fails('sign place buffer=999', 'E158:')
344 call assert_fails('sign jump buffer=999', 'E158:')
345 call assert_fails('sign jump 1 file=', 'E158:')
346 call assert_fails('sign jump 1 group=', 'E474:')
347 call assert_fails('sign jump 1 name=', 'E474:')
348 call assert_fails('sign jump 1 name=Sign1', 'E474:')
349 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200350 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100351 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100352 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
353 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100354 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100355 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
356 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100357 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100358 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
359 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100360 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100361 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
362 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100363 " Sign identifier and '*' for :sign unplace
364 call assert_fails("sign unplace 2 *", 'E474:')
365 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100366 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
367 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100368 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100369 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
370 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100371 call assert_fails("sign unplace 1 xxx", 'E474:')
372 call assert_fails("sign unplace * xxx", 'E474:')
373 call assert_fails("sign unplace xxx", 'E474:')
374 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100375 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100376 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100377 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100378 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100379 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100380 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100381 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100382 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100383 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100384 " Placing a sign with only sign identifier
385 call assert_fails("sign place 2", 'E474:')
386 " Placing a sign with only a name
387 call assert_fails("sign place abc", 'E474:')
388 " Placing a sign with only line number
389 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100390 " Placing a sign with only sign group
391 call assert_fails("sign place 5 group=g1", 'E474:')
392 call assert_fails("sign place 5 group=*", 'E474:')
393 " Placing a sign with only sign priority
394 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100395
396 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200397endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200398
399func Test_sign_delete_buffer()
400 new
401 sign define Sign text=x
402 let bufnr = bufnr('%')
403 new
404 exe 'bd ' . bufnr
405 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
406 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
407 sign unplace 61
408 sign undefine Sign
409endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100410
Bram Moolenaard933c822019-08-21 13:45:16 +0200411" Ignore error: E255: Couldn't read in sign data!
412" This error can happen when running in the GUI.
413" Some gui like Motif do not support the png icon format.
414func Sign_command_ignore_error(cmd)
415 try
416 exe a:cmd
417 catch /E255:/
418 endtry
419endfunc
420
421" ignore error: E255: Couldn't read in sign data!
422" This error can happen when running in gui.
423func Sign_define_ignore_error(name, attr)
424 try
425 call sign_define(a:name, a:attr)
426 catch /E255:/
427 endtry
428endfunc
429
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100430" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100431func Test_sign_funcs()
432 " Remove all the signs
433 call sign_unplace('*')
434 call sign_undefine()
435
436 " Tests for sign_define()
Bram Moolenaare413ea02021-11-24 16:20:13 +0000437 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error',
James McCoya80aad72021-12-22 19:45:28 +0000438 \ 'culhl': 'Visual', 'numhl': 'Number'}
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200439 call assert_equal(0, "sign1"->sign_define(attr))
James McCoya80aad72021-12-22 19:45:28 +0000440 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error', 'linehl' : 'Search',
441 \ 'culhl' : 'Visual', 'numhl': 'Number', 'text' : '=>'}],
Bram Moolenaare413ea02021-11-24 16:20:13 +0000442 \ sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100443
444 " Define a new sign without attributes and then update it
445 call sign_define("sign2")
446 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
James McCoya80aad72021-12-22 19:45:28 +0000447 \ 'culhl': 'DiffDelete', 'numhl': 'Number', 'icon' : 'sign2.ico'}
Bram Moolenaard933c822019-08-21 13:45:16 +0200448 call Sign_define_ignore_error("sign2", attr)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100449 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000450 \ 'linehl' : 'DiffAdd', 'culhl' : 'DiffDelete', 'text' : '!!',
James McCoya80aad72021-12-22 19:45:28 +0000451 \ 'numhl': 'Number', 'icon' : 'sign2.ico'}],
452 \ "sign2"->sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100453
454 " Test for a sign name with digits
455 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
456 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
457 \ sign_getdefined(0002))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200458 eval 0002->sign_undefine()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100459
460 " Tests for invalid arguments to sign_define()
461 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
462 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200463 call assert_fails('call sign_define({})', 'E731:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100464 call assert_fails('call sign_define("sign6", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100465
466 " Tests for sign_getdefined()
467 call assert_equal([], sign_getdefined("none"))
468 call assert_fails('call sign_getdefined({})', 'E731:')
469
470 " Tests for sign_place()
Bram Moolenaar56564962022-10-10 22:39:42 +0100471 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100472 edit Xsign
473
474 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
475 \ {'lnum' : 20}))
476 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
477 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
478 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
479 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
480 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
481 \ 'priority' : 10}]}],
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200482 \ '%'->sign_getplaced({'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100483 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
484 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
485 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100486 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100487
488 " Tests for invalid arguments to sign_place()
489 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
490 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100491 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100492 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
493 \ {"lnum" : 30})', 'E474:')
494 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
495 \ {"lnum" : 30})', 'E155:')
496 call assert_fails('call sign_place(10, "", "", "Xsign",
497 \ {"lnum" : 30})', 'E155:')
498 call assert_fails('call sign_place(10, "", [], "Xsign",
499 \ {"lnum" : 30})', 'E730:')
500 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
501 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100502 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100503 \ 'E158:')
504 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200505 \ 'E730:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100506 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200507 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100508 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200509 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100510 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200511 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100512 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
513
514 " Tests for sign_getplaced()
515 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
516 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
517 \ 'priority' : 10}]}],
518 \ sign_getplaced(bufnr('Xsign')))
519 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
520 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
521 \ 'priority' : 10}]}],
522 \ sign_getplaced())
523 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100524 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100525 call assert_fails('call sign_getplaced(-1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100526 call assert_fails('call sign_getplaced("Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100527 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
528 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
529 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
530 \ 'E745:')
531 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
532 \ sign_getplaced('Xsign', {'id' : 44}))
533 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
534 \ 'E745:')
535
536 " Tests for sign_unplace()
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200537 eval 20->sign_place('', 'sign2', 'Xsign', {"lnum" : 30})
Bram Moolenaar162b7142018-12-21 15:17:36 +0100538 call assert_equal(0, sign_unplace('',
539 \ {'id' : 20, 'buffer' : 'Xsign'}))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200540 call assert_equal(-1, ''->sign_unplace(
Bram Moolenaar162b7142018-12-21 15:17:36 +0100541 \ {'id' : 30, 'buffer' : 'Xsign'}))
542 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
543 call assert_fails("call sign_unplace('',
544 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
545 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100546 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100547 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100548 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100549 call assert_fails("call sign_unplace('g1', 'mySign')", 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100550
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200551 call sign_unplace('*')
552
553 " Test for modifying a placed sign
554 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
555 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
556 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
557 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
558 \ 'priority' : 10}]}],
559 \ sign_getplaced())
560
Bram Moolenaar162b7142018-12-21 15:17:36 +0100561 " Tests for sign_undefine()
562 call assert_equal(0, sign_undefine("sign1"))
563 call assert_equal([], sign_getdefined("sign1"))
564 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200565 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100566
Bram Moolenaar42aff462019-08-21 13:20:29 +0200567 " Test for using '.' as the line number for sign_place()
Bram Moolenaard933c822019-08-21 13:45:16 +0200568 call Sign_define_ignore_error("sign1", attr)
Bram Moolenaar42aff462019-08-21 13:20:29 +0200569 call cursor(22, 1)
570 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
571 \ {'lnum' : '.'}))
572 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
573 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
574 \ 'priority' : 10}]}],
575 \ sign_getplaced('%', {'lnum' : 22}))
576
Bram Moolenaar162b7142018-12-21 15:17:36 +0100577 call sign_unplace('*')
578 call sign_undefine()
579 enew | only
580endfunc
581
582" Tests for sign groups
583func Test_sign_group()
584 enew | only
585 " Remove all the signs
586 call sign_unplace('*')
587 call sign_undefine()
588
Bram Moolenaar56564962022-10-10 22:39:42 +0100589 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100590
591 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
592 call assert_equal(0, sign_define("sign1", attr))
593
594 edit Xsign
595 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100596
597 " Error case
598 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
599 \ {'lnum' : 30})", 'E730:')
600
601 " place three signs with the same identifier. One in the global group and
602 " others in the named groups
603 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
604 \ {'lnum' : 10}))
605 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
606 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
607
608 " Test for sign_getplaced() with group
609 let s = sign_getplaced('Xsign')
610 call assert_equal(1, len(s[0].signs))
611 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100612 let s = sign_getplaced(bnum, {'group' : ''})
613 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
614 \ 'priority' : 10}], s[0].signs)
615 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100616 let s = sign_getplaced(bnum, {'group' : 'g2'})
617 call assert_equal('g2', s[0].signs[0].group)
618 let s = sign_getplaced(bnum, {'group' : 'g3'})
619 call assert_equal([], s[0].signs)
620 let s = sign_getplaced(bnum, {'group' : '*'})
621 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
622 \ 'priority' : 10},
623 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
624 \ 'priority' : 10},
625 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
626 \ 'priority' : 10}],
627 \ s[0].signs)
628
629 " Test for sign_getplaced() with id
630 let s = sign_getplaced(bnum, {'id' : 5})
631 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
632 \ 'priority' : 10}],
633 \ s[0].signs)
634 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
635 call assert_equal(
636 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
637 \ 'priority' : 10}],
638 \ s[0].signs)
639 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
640 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
641 \ 'priority' : 10},
642 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
643 \ 'priority' : 10},
644 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
645 \ 'priority' : 10}],
646 \ s[0].signs)
647 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
648 call assert_equal([], s[0].signs)
649
650 " Test for sign_getplaced() with lnum
651 let s = sign_getplaced(bnum, {'lnum' : 20})
652 call assert_equal([], s[0].signs)
653 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
654 call assert_equal(
655 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
656 \ 'priority' : 10}],
657 \ s[0].signs)
658 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
659 call assert_equal(
660 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
661 \ 'priority' : 10}],
662 \ s[0].signs)
663 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
664 call assert_equal([], s[0].signs)
665
666 " Error case
667 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
668 \ 'E730:')
669
670 " Clear the sign in global group
671 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
672 let s = sign_getplaced(bnum, {'group' : '*'})
673 call assert_equal([
674 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
675 \ 'priority' : 10},
676 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
677 \ 'priority' : 10}],
678 \ s[0].signs)
679
680 " Clear the sign in one of the groups
681 call sign_unplace('g1', {'buffer' : 'Xsign'})
682 let s = sign_getplaced(bnum, {'group' : '*'})
683 call assert_equal([
684 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
685 \ 'priority' : 10}],
686 \ s[0].signs)
687
688 " Clear all the signs from the buffer
689 call sign_unplace('*', {'buffer' : bnum})
690 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
691
692 " Clear sign across groups using an identifier
693 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
694 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
695 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
696 call assert_equal(0, sign_unplace('*', {'id' : 25}))
697 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
698
699 " Error case
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +0100700 call assert_fails("call sign_unplace({})", 'E1174:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100701
702 " Place a sign in the global group and try to delete it using a group
703 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
704 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
705
706 " Place signs in multiple groups and delete all the signs in one of the
707 " group
708 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
709 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
710 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
711 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
712 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
713 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
714 call assert_equal(0, sign_unplace('g1'))
715 let s = sign_getplaced(bnum, {'group' : 'g1'})
716 call assert_equal([], s[0].signs)
717 let s = sign_getplaced(bnum)
718 call assert_equal(2, len(s[0].signs))
719 let s = sign_getplaced(bnum, {'group' : 'g2'})
720 call assert_equal('g2', s[0].signs[0].group)
721 call assert_equal(0, sign_unplace('', {'id' : 5}))
722 call assert_equal(0, sign_unplace('', {'id' : 6}))
723 let s = sign_getplaced(bnum, {'group' : 'g2'})
724 call assert_equal('g2', s[0].signs[0].group)
725 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
726
727 call sign_unplace('*')
728
729 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100730 sign place 5 line=10 name=sign1 file=Xsign
731 sign place 5 group=g1 line=10 name=sign1 file=Xsign
732 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100733
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100734 " Tests for the ':sign place' command
735
736 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100737 let a = execute('sign place file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100738 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100739 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100740
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100741 " :sign place group={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100742 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100743 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100744 \ " line=10 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100745
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100746 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100747 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100748 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100749 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
750 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
751 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100752
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100753 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100754 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100755 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
756
757 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100758 let bnum = bufnr('Xsign')
759 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
760 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
761 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
762
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100763 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100764 let a = execute('sign place buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100765 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100766 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100767
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100768 " :sign place group={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100769 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100770 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100771 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100772
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100773 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100774 let a = execute('sign place group=* buffer=' . bnum)
775 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100776 \ " line=10 id=5 name=sign1 priority=10\n" .
777 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
778 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100779
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100780 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100781 let a = execute('sign place group=xyz buffer=' . bnum)
782 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
783
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100784 " :sign place
785 let a = execute('sign place')
786 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100787 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100788
Bram Moolenaarb589f952019-01-07 22:10:00 +0100789 " Place signs in more than one buffer and list the signs
790 split foo
791 set buftype=nofile
792 sign place 25 line=76 name=sign1 priority=99 file=foo
793 let a = execute('sign place')
794 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
795 \ " line=10 id=5 name=sign1 priority=10\n" .
796 \ "Signs for foo:\n" .
797 \ " line=76 id=25 name=sign1 priority=99\n", a)
798 close
799 bwipe foo
800
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100801 " :sign place group={group}
802 let a = execute('sign place group=g1')
803 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100804 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100805
806 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100807 let a = execute('sign place group=*')
808 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100809 \ " line=10 id=5 name=sign1 priority=10\n" .
810 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
811 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100812
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100813 " Test for ':sign jump' command with groups
814 sign jump 5 group=g1 file=Xsign
815 call assert_equal(11, line('.'))
816 call assert_equal('Xsign', bufname(''))
817 sign jump 5 group=g2 file=Xsign
818 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100819
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100820 " Test for :sign jump command without the filename or buffer
821 sign jump 5
822 call assert_equal(10, line('.'))
823 sign jump 5 group=g1
824 call assert_equal(11, line('.'))
825
Bram Moolenaar162b7142018-12-21 15:17:36 +0100826 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100827 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100828
Bram Moolenaar162b7142018-12-21 15:17:36 +0100829 call sign_unplace('*')
830 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100831 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100832endfunc
833
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100834" Place signs used for ":sign unplace" command test
835func Place_signs_for_test()
836 call sign_unplace('*')
837
838 sign place 3 line=10 name=sign1 file=Xsign1
839 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
840 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
841 sign place 4 line=15 name=sign1 file=Xsign1
842 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
843 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
844 sign place 5 line=20 name=sign1 file=Xsign2
845 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
846 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
847 sign place 6 line=25 name=sign1 file=Xsign2
848 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
849 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
850endfunc
851
852" Place multiple signs in a single line for test
853func Place_signs_at_line_for_test()
854 call sign_unplace('*')
855 sign place 3 line=13 name=sign1 file=Xsign1
856 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
857 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
858 sign place 4 line=13 name=sign1 file=Xsign1
859 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
860 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
861endfunc
862
863" Tests for the ':sign unplace' command
864func Test_sign_unplace()
865 enew | only
866 " Remove all the signs
867 call sign_unplace('*')
868 call sign_undefine()
869
870 " Create two files and define signs
Bram Moolenaar56564962022-10-10 22:39:42 +0100871 call writefile(repeat(["Sun is shining"], 30), "Xsign1", 'D')
872 call writefile(repeat(["It is beautiful"], 30), "Xsign2", 'D')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100873
874 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
875 call sign_define("sign1", attr)
876
877 edit Xsign1
878 let bnum1 = bufnr('%')
879 split Xsign2
880 let bnum2 = bufnr('%')
881
882 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
883 \ 'priority' : 10},
884 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
885 \ 'priority' : 10},
886 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
887 \ 'priority' : 10},
888 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
889 \ 'priority' : 10},
890 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
891 \ 'priority' : 10},
892 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
893 \ 'priority' : 10},]
894 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
895 \ 'priority' : 10},
896 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
897 \ 'priority' : 10},
898 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
899 \ 'priority' : 10},
900 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
901 \ 'priority' : 10},
902 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
903 \ 'priority' : 10},
904 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
905 \ 'priority' : 10},]
906
907 " Test for :sign unplace {id} file={fname}
908 call Place_signs_for_test()
909 sign unplace 3 file=Xsign1
910 sign unplace 6 file=Xsign2
911 call assert_equal(
912 \ filter(copy(signs1),
913 \ {idx, val -> val.id != 3 || 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} file={fname}
921 call Place_signs_for_test()
922 sign unplace 4 group=g1 file=Xsign1
923 sign unplace 5 group=g2 file=Xsign2
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 != 5 || val.group != 'g2'}),
931 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
932
933 " Test for :sign unplace {id} group=* file={fname}
934 call Place_signs_for_test()
935 sign unplace 3 group=* file=Xsign1
936 sign unplace 6 group=* file=Xsign2
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 != 6}),
944 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
945
946 " Test for :sign unplace * file={fname}
947 call Place_signs_for_test()
948 sign unplace * file=Xsign1
949 call assert_equal(
950 \ filter(copy(signs1),
951 \ {idx, val -> val.group != ''}),
952 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
953 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
954
955 " Test for :sign unplace * group={group} file={fname}
956 call Place_signs_for_test()
957 sign unplace * group=g1 file=Xsign1
958 sign unplace * group=g2 file=Xsign2
959 call assert_equal(
960 \ filter(copy(signs1),
961 \ {idx, val -> val.group != 'g1'}),
962 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
963 call assert_equal(
964 \ filter(copy(signs2),
965 \ {idx, val -> val.group != 'g2'}),
966 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
967
968 " Test for :sign unplace * group=* file={fname}
969 call Place_signs_for_test()
970 sign unplace * group=* file=Xsign2
971 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
972 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
973
974 " Test for :sign unplace {id} buffer={nr}
975 call Place_signs_for_test()
976 exe 'sign unplace 3 buffer=' . bnum1
977 exe 'sign unplace 6 buffer=' . bnum2
978 call assert_equal(
979 \ filter(copy(signs1),
980 \ {idx, val -> val.id != 3 || val.group != ''}),
981 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
982 call assert_equal(
983 \ filter(copy(signs2),
984 \ {idx, val -> val.id != 6 || val.group != ''}),
985 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
986
987 " Test for :sign unplace {id} group={group} buffer={nr}
988 call Place_signs_for_test()
989 exe 'sign unplace 4 group=g1 buffer=' . bnum1
990 exe 'sign unplace 5 group=g2 buffer=' . bnum2
991 call assert_equal(
992 \ filter(copy(signs1),
993 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
994 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
995 call assert_equal(
996 \ filter(copy(signs2),
997 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
998 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
999
1000 " Test for :sign unplace {id} group=* buffer={nr}
1001 call Place_signs_for_test()
1002 exe 'sign unplace 3 group=* buffer=' . bnum1
1003 exe 'sign unplace 6 group=* buffer=' . bnum2
1004 call assert_equal(
1005 \ filter(copy(signs1),
1006 \ {idx, val -> val.id != 3}),
1007 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1008 call assert_equal(
1009 \ filter(copy(signs2),
1010 \ {idx, val -> val.id != 6}),
1011 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1012
1013 " Test for :sign unplace * buffer={nr}
1014 call Place_signs_for_test()
1015 exe 'sign unplace * buffer=' . bnum1
1016 call assert_equal(
1017 \ filter(copy(signs1),
1018 \ {idx, val -> val.group != ''}),
1019 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1020 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1021
1022 " Test for :sign unplace * group={group} buffer={nr}
1023 call Place_signs_for_test()
1024 exe 'sign unplace * group=g1 buffer=' . bnum1
1025 exe 'sign unplace * group=g2 buffer=' . bnum2
1026 call assert_equal(
1027 \ filter(copy(signs1),
1028 \ {idx, val -> val.group != 'g1'}),
1029 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1030 call assert_equal(
1031 \ filter(copy(signs2),
1032 \ {idx, val -> val.group != 'g2'}),
1033 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1034
1035 " Test for :sign unplace * group=* buffer={nr}
1036 call Place_signs_for_test()
1037 exe 'sign unplace * group=* buffer=' . bnum2
1038 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1039 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1040
1041 " Test for :sign unplace {id}
1042 call Place_signs_for_test()
1043 sign unplace 4
1044 sign unplace 6
1045 call assert_equal(
1046 \ filter(copy(signs1),
1047 \ {idx, val -> val.id != 4 || val.group != ''}),
1048 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1049 call assert_equal(
1050 \ filter(copy(signs2),
1051 \ {idx, val -> val.id != 6 || val.group != ''}),
1052 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1053
1054 " Test for :sign unplace {id} group={group}
1055 call Place_signs_for_test()
1056 sign unplace 4 group=g1
1057 sign unplace 6 group=g2
1058 call assert_equal(
1059 \ filter(copy(signs1),
1060 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1061 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1062 call assert_equal(
1063 \ filter(copy(signs2),
1064 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1065 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1066
1067 " Test for :sign unplace {id} group=*
1068 call Place_signs_for_test()
1069 sign unplace 3 group=*
1070 sign unplace 5 group=*
1071 call assert_equal(
1072 \ filter(copy(signs1),
1073 \ {idx, val -> val.id != 3}),
1074 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1075 call assert_equal(
1076 \ filter(copy(signs2),
1077 \ {idx, val -> val.id != 5}),
1078 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1079
1080 " Test for :sign unplace *
1081 call Place_signs_for_test()
1082 sign unplace *
1083 call assert_equal(
1084 \ filter(copy(signs1),
1085 \ {idx, val -> val.group != ''}),
1086 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1087 call assert_equal(
1088 \ filter(copy(signs2),
1089 \ {idx, val -> val.group != ''}),
1090 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1091
1092 " Test for :sign unplace * group={group}
1093 call Place_signs_for_test()
1094 sign unplace * group=g1
1095 call assert_equal(
1096 \ filter(copy(signs1),
1097 \ {idx, val -> val.group != 'g1'}),
1098 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1099 call assert_equal(
1100 \ filter(copy(signs2),
1101 \ {idx, val -> val.group != 'g1'}),
1102 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1103
1104 " Test for :sign unplace * group=*
1105 call Place_signs_for_test()
1106 sign unplace * group=*
1107 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1108 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1109
1110 " Negative test cases
1111 call Place_signs_for_test()
1112 sign unplace 3 group=xy file=Xsign1
1113 sign unplace * group=xy file=Xsign1
1114 silent! sign unplace * group=* file=FileNotPresent
1115 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1116 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1117
1118 " Tests for removing sign at the current cursor position
1119
1120 " Test for ':sign unplace'
1121 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1122 \ 'priority' : 10},
1123 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1124 \ 'priority' : 10},
1125 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1126 \ 'priority' : 10},
1127 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1128 \ 'priority' : 10},
1129 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1130 \ 'priority' : 10},
1131 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1132 \ 'priority' : 10},]
1133 exe bufwinnr('Xsign1') . 'wincmd w'
1134 call cursor(13, 1)
1135
1136 " Should remove only one sign in the global group
1137 call Place_signs_at_line_for_test()
1138 sign unplace
1139 call assert_equal(
1140 \ filter(copy(signs1),
1141 \ {idx, val -> val.id != 4 || val.group != ''}),
1142 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1143 " Should remove the second sign in the global group
1144 sign unplace
1145 call assert_equal(
1146 \ filter(copy(signs1),
1147 \ {idx, val -> val.group != ''}),
1148 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1149
1150 " Test for ':sign unplace group={group}'
1151 call Place_signs_at_line_for_test()
1152 " Should remove only one sign in group g1
1153 sign unplace group=g1
1154 call assert_equal(
1155 \ filter(copy(signs1),
1156 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1157 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1158 sign unplace group=g2
1159 call assert_equal(
1160 \ filter(copy(signs1),
1161 \ {idx, val -> val.id != 4 || val.group == ''}),
1162 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1163
1164 " Test for ':sign unplace group=*'
1165 call Place_signs_at_line_for_test()
1166 sign unplace group=*
1167 sign unplace group=*
1168 sign unplace group=*
1169 call assert_equal(
1170 \ filter(copy(signs1),
1171 \ {idx, val -> val.id != 4}),
1172 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1173 sign unplace group=*
1174 sign unplace group=*
1175 sign unplace group=*
1176 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1177
1178 call sign_unplace('*')
1179 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001180 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001181endfunc
1182
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001183" Tests for auto-generating the sign identifier.
1184func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001185 enew | only
1186 call sign_unplace('*')
1187 call sign_undefine()
1188
1189 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1190 call assert_equal(0, sign_define("sign1", attr))
1191
Bram Moolenaar56564962022-10-10 22:39:42 +01001192 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001193 edit Xsign
1194
1195 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1196 \ {'lnum' : 10}))
1197 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1198 \ {'lnum' : 12}))
1199 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1200 \ {'lnum' : 14}))
1201 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001202 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001203 \ {'lnum' : 12}))
1204
1205 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1206 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001207 " Check for the next generated sign id in this group
1208 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1209 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001210 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1211 call assert_equal(10,
1212 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1213
Bram Moolenaar162b7142018-12-21 15:17:36 +01001214 call sign_unplace('*')
1215 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001216 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001217endfunc
1218
1219" Test for sign priority
1220func Test_sign_priority()
1221 enew | only
1222 call sign_unplace('*')
1223 call sign_undefine()
1224
1225 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1226 call sign_define("sign1", attr)
1227 call sign_define("sign2", attr)
1228 call sign_define("sign3", attr)
1229
1230 " Place three signs with different priority in the same line
Bram Moolenaar56564962022-10-10 22:39:42 +01001231 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001232 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001233
1234 call sign_place(1, 'g1', 'sign1', 'Xsign',
1235 \ {'lnum' : 11, 'priority' : 50})
1236 call sign_place(2, 'g2', 'sign2', 'Xsign',
1237 \ {'lnum' : 11, 'priority' : 100})
1238 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1239 let s = sign_getplaced('Xsign', {'group' : '*'})
1240 call assert_equal([
1241 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1242 \ 'priority' : 100},
1243 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1244 \ 'priority' : 50},
1245 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1246 \ 'priority' : 10}],
1247 \ s[0].signs)
1248
Bram Moolenaar64416122019-06-07 21:37:13 +02001249 call sign_unplace('*')
1250
1251 " Three signs on different lines with changing priorities
1252 call sign_place(1, '', 'sign1', 'Xsign',
1253 \ {'lnum' : 11, 'priority' : 50})
1254 call sign_place(2, '', 'sign2', 'Xsign',
1255 \ {'lnum' : 12, 'priority' : 60})
1256 call sign_place(3, '', 'sign3', 'Xsign',
1257 \ {'lnum' : 13, 'priority' : 70})
1258 call sign_place(2, '', 'sign2', 'Xsign',
1259 \ {'lnum' : 12, 'priority' : 40})
1260 call sign_place(3, '', 'sign3', 'Xsign',
1261 \ {'lnum' : 13, 'priority' : 30})
1262 call sign_place(1, '', 'sign1', 'Xsign',
1263 \ {'lnum' : 11, 'priority' : 50})
1264 let s = sign_getplaced('Xsign', {'group' : '*'})
1265 call assert_equal([
1266 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1267 \ 'priority' : 50},
1268 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1269 \ 'priority' : 40},
1270 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1271 \ 'priority' : 30}],
1272 \ s[0].signs)
1273
1274 call sign_unplace('*')
1275
1276 " Two signs on the same line with changing priorities
1277 call sign_place(1, '', 'sign1', 'Xsign',
1278 \ {'lnum' : 4, 'priority' : 20})
1279 call sign_place(2, '', 'sign2', 'Xsign',
1280 \ {'lnum' : 4, 'priority' : 30})
1281 let s = sign_getplaced('Xsign', {'group' : '*'})
1282 call assert_equal([
1283 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1284 \ 'priority' : 30},
1285 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1286 \ 'priority' : 20}],
1287 \ s[0].signs)
1288 " Change the priority of the last sign to highest
1289 call sign_place(1, '', 'sign1', 'Xsign',
1290 \ {'lnum' : 4, 'priority' : 40})
1291 let s = sign_getplaced('Xsign', {'group' : '*'})
1292 call assert_equal([
1293 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1294 \ 'priority' : 40},
1295 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1296 \ 'priority' : 30}],
1297 \ s[0].signs)
1298 " Change the priority of the first sign to lowest
1299 call sign_place(1, '', 'sign1', 'Xsign',
1300 \ {'lnum' : 4, 'priority' : 25})
1301 let s = sign_getplaced('Xsign', {'group' : '*'})
1302 call assert_equal([
1303 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1304 \ 'priority' : 30},
1305 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1306 \ 'priority' : 25}],
1307 \ s[0].signs)
1308 call sign_place(1, '', 'sign1', 'Xsign',
1309 \ {'lnum' : 4, 'priority' : 45})
1310 call sign_place(2, '', 'sign2', 'Xsign',
1311 \ {'lnum' : 4, 'priority' : 55})
1312 let s = sign_getplaced('Xsign', {'group' : '*'})
1313 call assert_equal([
1314 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1315 \ 'priority' : 55},
1316 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1317 \ 'priority' : 45}],
1318 \ s[0].signs)
1319
1320 call sign_unplace('*')
1321
1322 " Three signs on the same line with changing priorities
1323 call sign_place(1, '', 'sign1', 'Xsign',
1324 \ {'lnum' : 4, 'priority' : 40})
1325 call sign_place(2, '', 'sign2', 'Xsign',
1326 \ {'lnum' : 4, 'priority' : 30})
1327 call sign_place(3, '', 'sign3', 'Xsign',
1328 \ {'lnum' : 4, 'priority' : 20})
1329 let s = sign_getplaced('Xsign', {'group' : '*'})
1330 call assert_equal([
1331 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1332 \ 'priority' : 40},
1333 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1334 \ 'priority' : 30},
1335 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1336 \ 'priority' : 20}],
1337 \ s[0].signs)
1338
1339 " Change the priority of the middle sign to the highest
1340 call sign_place(2, '', 'sign2', 'Xsign',
1341 \ {'lnum' : 4, 'priority' : 50})
1342 let s = sign_getplaced('Xsign', {'group' : '*'})
1343 call assert_equal([
1344 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1345 \ 'priority' : 50},
1346 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1347 \ 'priority' : 40},
1348 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1349 \ 'priority' : 20}],
1350 \ s[0].signs)
1351
1352 " Change the priority of the middle sign to the lowest
1353 call sign_place(1, '', 'sign1', 'Xsign',
1354 \ {'lnum' : 4, 'priority' : 15})
1355 let s = sign_getplaced('Xsign', {'group' : '*'})
1356 call assert_equal([
1357 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1358 \ 'priority' : 50},
1359 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1360 \ 'priority' : 20},
1361 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1362 \ 'priority' : 15}],
1363 \ s[0].signs)
1364
1365 " Change the priority of the last sign to the highest
1366 call sign_place(1, '', 'sign1', 'Xsign',
1367 \ {'lnum' : 4, 'priority' : 55})
1368 let s = sign_getplaced('Xsign', {'group' : '*'})
1369 call assert_equal([
1370 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1371 \ 'priority' : 55},
1372 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1373 \ 'priority' : 50},
1374 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1375 \ 'priority' : 20}],
1376 \ s[0].signs)
1377
1378 " Change the priority of the first sign to the lowest
1379 call sign_place(1, '', 'sign1', 'Xsign',
1380 \ {'lnum' : 4, 'priority' : 15})
1381 let s = sign_getplaced('Xsign', {'group' : '*'})
1382 call assert_equal([
1383 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1384 \ 'priority' : 50},
1385 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1386 \ 'priority' : 20},
1387 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1388 \ 'priority' : 15}],
1389 \ s[0].signs)
1390
1391 call sign_unplace('*')
1392
1393 " Three signs on the same line with changing priorities along with other
1394 " signs
1395 call sign_place(1, '', 'sign1', 'Xsign',
1396 \ {'lnum' : 2, 'priority' : 10})
1397 call sign_place(2, '', 'sign1', 'Xsign',
1398 \ {'lnum' : 4, 'priority' : 30})
1399 call sign_place(3, '', 'sign2', 'Xsign',
1400 \ {'lnum' : 4, 'priority' : 20})
1401 call sign_place(4, '', 'sign3', 'Xsign',
1402 \ {'lnum' : 4, 'priority' : 25})
1403 call sign_place(5, '', 'sign2', 'Xsign',
1404 \ {'lnum' : 6, 'priority' : 80})
1405 let s = sign_getplaced('Xsign', {'group' : '*'})
1406 call assert_equal([
1407 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1408 \ 'priority' : 10},
1409 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1410 \ 'priority' : 30},
1411 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1412 \ 'priority' : 25},
1413 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1414 \ 'priority' : 20},
1415 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1416 \ 'priority' : 80}],
1417 \ s[0].signs)
1418
1419 " Change the priority of the first sign to lowest
1420 call sign_place(2, '', 'sign1', 'Xsign',
1421 \ {'lnum' : 4, 'priority' : 15})
1422 let s = sign_getplaced('Xsign', {'group' : '*'})
1423 call assert_equal([
1424 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1425 \ 'priority' : 10},
1426 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1427 \ 'priority' : 25},
1428 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1429 \ 'priority' : 20},
1430 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1431 \ 'priority' : 15},
1432 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1433 \ 'priority' : 80}],
1434 \ s[0].signs)
1435
1436 " Change the priority of the last sign to highest
1437 call sign_place(2, '', 'sign1', 'Xsign',
1438 \ {'lnum' : 4, 'priority' : 30})
1439 let s = sign_getplaced('Xsign', {'group' : '*'})
1440 call assert_equal([
1441 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1442 \ 'priority' : 10},
1443 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1444 \ 'priority' : 30},
1445 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1446 \ 'priority' : 25},
1447 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1448 \ 'priority' : 20},
1449 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1450 \ 'priority' : 80}],
1451 \ s[0].signs)
1452
1453 " Change the priority of the middle sign to lowest
1454 call sign_place(4, '', 'sign3', 'Xsign',
1455 \ {'lnum' : 4, 'priority' : 15})
1456 let s = sign_getplaced('Xsign', {'group' : '*'})
1457 call assert_equal([
1458 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1459 \ 'priority' : 10},
1460 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1461 \ 'priority' : 30},
1462 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1463 \ 'priority' : 20},
1464 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1465 \ 'priority' : 15},
1466 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1467 \ 'priority' : 80}],
1468 \ s[0].signs)
1469
1470 " Change the priority of the middle sign to highest
1471 call sign_place(3, '', 'sign2', 'Xsign',
1472 \ {'lnum' : 4, 'priority' : 35})
1473 let s = sign_getplaced('Xsign', {'group' : '*'})
1474 call assert_equal([
1475 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1476 \ 'priority' : 10},
1477 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1478 \ 'priority' : 35},
1479 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1480 \ 'priority' : 30},
1481 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1482 \ 'priority' : 15},
1483 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1484 \ 'priority' : 80}],
1485 \ s[0].signs)
1486
1487 call sign_unplace('*')
1488
1489 " Multiple signs with the same priority on the same line
1490 call sign_place(1, '', 'sign1', 'Xsign',
1491 \ {'lnum' : 4, 'priority' : 20})
1492 call sign_place(2, '', 'sign2', 'Xsign',
1493 \ {'lnum' : 4, 'priority' : 20})
1494 call sign_place(3, '', 'sign3', 'Xsign',
1495 \ {'lnum' : 4, 'priority' : 20})
1496 let s = sign_getplaced('Xsign', {'group' : '*'})
1497 call assert_equal([
1498 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1499 \ 'priority' : 20},
1500 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1501 \ 'priority' : 20},
1502 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1503 \ 'priority' : 20}],
1504 \ s[0].signs)
1505 " Place the last sign again with the same priority
1506 call sign_place(1, '', 'sign1', 'Xsign',
1507 \ {'lnum' : 4, 'priority' : 20})
1508 let s = sign_getplaced('Xsign', {'group' : '*'})
1509 call assert_equal([
1510 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1511 \ 'priority' : 20},
1512 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1513 \ 'priority' : 20},
1514 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1515 \ 'priority' : 20}],
1516 \ s[0].signs)
1517 " Place the first sign again with the same priority
1518 call sign_place(1, '', 'sign1', 'Xsign',
1519 \ {'lnum' : 4, 'priority' : 20})
1520 let s = sign_getplaced('Xsign', {'group' : '*'})
1521 call assert_equal([
1522 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1523 \ 'priority' : 20},
1524 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1525 \ 'priority' : 20},
1526 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1527 \ 'priority' : 20}],
1528 \ s[0].signs)
1529 " Place the middle sign again with the same priority
1530 call sign_place(3, '', 'sign3', 'Xsign',
1531 \ {'lnum' : 4, 'priority' : 20})
1532 let s = sign_getplaced('Xsign', {'group' : '*'})
1533 call assert_equal([
1534 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1535 \ 'priority' : 20},
1536 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1537 \ 'priority' : 20},
1538 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1539 \ 'priority' : 20}],
1540 \ s[0].signs)
1541
1542 call sign_unplace('*')
1543
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001544 " Place multiple signs with same id on a line with different priority
1545 call sign_place(1, '', 'sign1', 'Xsign',
1546 \ {'lnum' : 5, 'priority' : 20})
1547 call sign_place(1, '', 'sign2', 'Xsign',
1548 \ {'lnum' : 5, 'priority' : 10})
1549 let s = sign_getplaced('Xsign', {'lnum' : 5})
1550 call assert_equal([
1551 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1552 \ 'priority' : 10}],
1553 \ s[0].signs)
1554 call sign_place(1, '', 'sign2', 'Xsign',
1555 \ {'lnum' : 5, 'priority' : 5})
1556 let s = sign_getplaced('Xsign', {'lnum' : 5})
1557 call assert_equal([
1558 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1559 \ 'priority' : 5}],
1560 \ s[0].signs)
1561
Bram Moolenaar162b7142018-12-21 15:17:36 +01001562 " Error case
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001563 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign', [])", 'E1206:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001564 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1565 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001566 call sign_unplace('*')
1567
1568 " Tests for the :sign place command with priority
1569 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1570 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1571 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1572 let a = execute('sign place group=*')
1573 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001574 \ " line=10 id=5 name=sign1 priority=30\n" .
1575 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1576 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001577
1578 " Test for :sign place group={group}
1579 let a = execute('sign place group=g1')
1580 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001581 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001582
1583 call sign_unplace('*')
1584 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001585 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001586endfunc
1587
1588" Tests for memory allocation failures in sign functions
1589func Test_sign_memfailures()
Bram Moolenaar56564962022-10-10 22:39:42 +01001590 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001591 edit Xsign
1592
1593 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1594 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1595 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1596 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1597 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1598 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1599 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1600
1601 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1602 call sign_define("sign1", attr)
1603 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1604 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1605
1606 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1607 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1608 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1609 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1610 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1611
1612 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1613 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1614 \ 'E342:')
1615
1616 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1617 call assert_fails('call getbufinfo()', 'E342:')
1618 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1619 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1620 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1621 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1622 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1623
1624 call sign_unplace('*')
1625 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001626 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001627endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001628
1629" Test for auto-adjusting the line number of a placed sign.
1630func Test_sign_lnum_adjust()
1631 enew! | only!
1632
1633 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001634 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001635 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1636 let l = sign_getplaced(bufnr(''))
1637 call assert_equal(3, l[0].signs[0].lnum)
1638
1639 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001640 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001641 let l = sign_getplaced(bufnr(''))
1642 call assert_equal(6, l[0].signs[0].lnum)
1643
1644 " Delete some lines before the sign and check the sign line number
1645 call deletebufline('%', 1, 2)
1646 let l = sign_getplaced(bufnr(''))
1647 call assert_equal(4, l[0].signs[0].lnum)
1648
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001649 " Insert some lines after the sign and check the sign line number
1650 call append(5, ['DA', 'DB'])
1651 let l = sign_getplaced(bufnr(''))
1652 call assert_equal(4, l[0].signs[0].lnum)
1653
1654 " Delete some lines after the sign and check the sign line number
1655 call deletebufline('', 6, 7)
1656 let l = sign_getplaced(bufnr(''))
1657 call assert_equal(4, l[0].signs[0].lnum)
1658
1659 " Break the undo. Otherwise the undo operation below will undo all the
1660 " changes made by this function.
1661 let &undolevels=&undolevels
1662
1663 " Delete the line with the sign
1664 call deletebufline('', 4)
1665 let l = sign_getplaced(bufnr(''))
1666 call assert_equal(4, l[0].signs[0].lnum)
1667
1668 " Undo the delete operation
1669 undo
1670 let l = sign_getplaced(bufnr(''))
1671 call assert_equal(5, l[0].signs[0].lnum)
1672
1673 " Break the undo
1674 let &undolevels=&undolevels
1675
1676 " Delete few lines at the end of the buffer including the line with the sign
1677 " Sign line number should not change (as it is placed outside of the buffer)
1678 call deletebufline('', 3, 6)
1679 let l = sign_getplaced(bufnr(''))
1680 call assert_equal(5, l[0].signs[0].lnum)
1681
1682 " Undo the delete operation. Sign should be restored to the previous line
1683 undo
1684 let l = sign_getplaced(bufnr(''))
1685 call assert_equal(5, l[0].signs[0].lnum)
1686
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001687 sign unplace * group=*
1688 sign undefine sign1
1689 enew!
1690endfunc
1691
1692" Test for changing the type of a placed sign
1693func Test_sign_change_type()
1694 enew! | only!
1695
1696 sign define sign1 text=#> linehl=Comment
1697 sign define sign2 text=@@ linehl=Comment
1698
1699 call setline(1, ['A', 'B', 'C', 'D'])
1700 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1701 let l = sign_getplaced(bufnr(''))
1702 call assert_equal('sign1', l[0].signs[0].name)
1703 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1704 let l = sign_getplaced(bufnr(''))
1705 call assert_equal('sign2', l[0].signs[0].name)
1706 call sign_place(4, '', 'sign1', '')
1707 let l = sign_getplaced(bufnr(''))
1708 call assert_equal('sign1', l[0].signs[0].name)
1709
1710 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1711 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1712 call assert_equal('sign1', l[0].signs[0].name)
1713 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1714 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1715 call assert_equal('sign2', l[0].signs[0].name)
1716 call sign_place(4, 'g1', 'sign1', '')
1717 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1718 call assert_equal('sign1', l[0].signs[0].name)
1719
1720 sign unplace * group=*
1721 sign undefine sign1
1722 sign undefine sign2
1723 enew!
1724endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001725
1726" Test for the sign_jump() function
1727func Test_sign_jump_func()
1728 enew! | only!
1729
1730 sign define sign1 text=#> linehl=Comment
1731
1732 edit foo
1733 set buftype=nofile
1734 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1735 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1736 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1737 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1738 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1739 split bar
1740 set buftype=nofile
1741 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1742 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1743 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1744 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1745 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1746
1747 let r = sign_jump(5, '', 'foo')
1748 call assert_equal(2, r)
1749 call assert_equal(2, line('.'))
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001750 let r = 6->sign_jump('g1', 'foo')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001751 call assert_equal(5, r)
1752 call assert_equal(5, line('.'))
1753 let r = sign_jump(5, '', 'bar')
1754 call assert_equal(2, r)
1755 call assert_equal(2, line('.'))
1756
1757 " Error cases
1758 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1759 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1760 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1761 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1762 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001763 call assert_fails('call sign_jump(2, "", {})', 'E731:')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001764 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1765
1766 sign unplace * group=*
1767 sign undefine sign1
1768 enew! | only!
1769endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001770
1771" Test for correct cursor position after the sign column appears or disappears.
1772func Test_sign_cursor_position()
Bram Moolenaar494e9062020-05-31 21:28:02 +02001773 CheckRunVimInTerminal
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001774
1775 let lines =<< trim END
1776 call setline(1, [repeat('x', 75), 'mmmm', 'yyyy'])
1777 call cursor(2,1)
1778 sign define s1 texthl=Search text==>
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001779 sign define s2 linehl=Pmenu
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001780 redraw
1781 sign place 10 line=2 name=s1
1782 END
Bram Moolenaar56564962022-10-10 22:39:42 +01001783 call writefile(lines, 'XtestSigncolumn', 'D')
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001784 let buf = RunVimInTerminal('-S XtestSigncolumn', {'rows': 6})
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001785 call VerifyScreenDump(buf, 'Test_sign_cursor_1', {})
1786
1787 " Change the sign text
1788 call term_sendkeys(buf, ":sign define s1 text=-)\<CR>")
1789 call VerifyScreenDump(buf, 'Test_sign_cursor_2', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001790
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001791 " Also place a line HL sign
1792 call term_sendkeys(buf, ":sign place 11 line=2 name=s2\<CR>")
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001793 call VerifyScreenDump(buf, 'Test_sign_cursor_3', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001794
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001795 " update cursor position calculation
1796 call term_sendkeys(buf, "lh")
1797 call term_sendkeys(buf, ":sign unplace 11\<CR>")
1798 call term_sendkeys(buf, ":sign unplace 10\<CR>")
1799 call VerifyScreenDump(buf, 'Test_sign_cursor_4', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001800
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001801 " 'cursorline' highlighting overrules sign
1802 call term_sendkeys(buf, ":sign place 12 line=2 name=s2\<CR>")
1803 call term_sendkeys(buf, ":set cursorline\<CR>")
1804 call term_sendkeys(buf, ":hi CursorLine ctermbg=Green\<CR>")
1805 call term_sendkeys(buf, "2G")
1806 call term_sendkeys(buf, ":\<CR>")
1807 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
zeertzjqb7acea12022-12-12 13:20:43 +00001808 call term_sendkeys(buf, ":set cursorlineopt=number,screenline\<CR>")
1809 call term_sendkeys(buf, ":\<CR>")
1810 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001811
1812 " sign highlighting overrules 'cursorline'
1813 call term_sendkeys(buf, ":sign unplace 12\<CR>")
1814 call term_sendkeys(buf, ":sign place 13 line=2 priority=100 name=s2\<CR>")
1815 call term_sendkeys(buf, ":\<CR>")
1816 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
zeertzjqb7acea12022-12-12 13:20:43 +00001817 call term_sendkeys(buf, ":set cursorlineopt&\<CR>")
1818 call term_sendkeys(buf, ":\<CR>")
1819 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001820
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001821 " clean up
1822 call StopVimInTerminal(buf)
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001823endfunc
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001824
1825" Return the 'len' characters in screen starting from (row,col)
1826func s:ScreenLine(row, col, len)
1827 let s = ''
1828 for i in range(a:len)
1829 let s .= nr2char(screenchar(a:row, a:col + i))
1830 endfor
1831 return s
1832endfunc
1833
1834" Test for 'signcolumn' set to 'number'.
1835func Test_sign_numcol()
1836 new
1837 call append(0, "01234")
1838 " With 'signcolumn' set to 'number', make sure sign is displayed in the
1839 " number column and line number is not displayed.
1840 set numberwidth=2
1841 set number
1842 set signcolumn=number
1843 sign define sign1 text==>
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001844 sign define sign2 text=ï¼¶
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001845 sign place 10 line=1 name=sign1
1846 redraw!
1847 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1848
1849 " With 'signcolumn' set to 'number', when there is no sign, make sure line
1850 " number is displayed in the number column
1851 sign unplace 10
1852 redraw!
1853 call assert_equal("1 01234", s:ScreenLine(1, 1, 7))
1854
1855 " Disable number column. Check whether sign is displayed in the sign column
1856 set numberwidth=4
1857 set nonumber
1858 sign place 10 line=1 name=sign1
1859 redraw!
1860 call assert_equal("=>01234", s:ScreenLine(1, 1, 7))
1861
1862 " Enable number column. Check whether sign is displayed in the number column
1863 set number
1864 redraw!
Bram Moolenaar4dff4ae2019-06-19 16:31:28 +02001865 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001866
1867 " Disable sign column. Make sure line number is displayed
1868 set signcolumn=no
1869 redraw!
1870 call assert_equal(" 1 01234", s:ScreenLine(1, 1, 9))
1871
1872 " Enable auto sign column. Make sure both sign and line number are displayed
1873 set signcolumn=auto
1874 redraw!
1875 call assert_equal("=> 1 01234", s:ScreenLine(1, 1, 11))
1876
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001877 " Test displaying signs in the number column with width 1
1878 call sign_unplace('*')
1879 call append(1, "abcde")
1880 call append(2, "01234")
1881 " Enable number column with width 1
1882 set number numberwidth=1 signcolumn=auto
1883 redraw!
1884 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1885 " Place a sign and make sure number column width remains the same
1886 sign place 20 line=2 name=sign1
1887 redraw!
1888 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1889 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1890 " Set 'signcolumn' to 'number', make sure the number column width increases
1891 set signcolumn=number
1892 redraw!
1893 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1894 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1895 " Set 'signcolumn' to 'auto', make sure the number column width is 1.
1896 set signcolumn=auto
1897 redraw!
1898 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1899 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1900 " Set 'signcolumn' to 'number', make sure the number column width is 2.
1901 set signcolumn=number
1902 redraw!
1903 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1904 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1905 " Disable 'number' column
1906 set nonumber
1907 redraw!
1908 call assert_equal("=>abcde", s:ScreenLine(2, 1, 7))
1909 call assert_equal(" 01234", s:ScreenLine(3, 1, 7))
1910 " Enable 'number' column
1911 set number
1912 redraw!
1913 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1914 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1915 " Remove the sign and make sure the width of the number column is 1.
1916 call sign_unplace('', {'id' : 20})
1917 redraw!
1918 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1919 " When the first sign is placed with 'signcolumn' set to number, verify that
1920 " the number column width increases
1921 sign place 30 line=1 name=sign1
1922 redraw!
1923 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1924 call assert_equal(" 2 abcde", s:ScreenLine(2, 1, 8))
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001925 " Add sign with multi-byte text
1926 set numberwidth=4
1927 sign place 40 line=2 name=sign2
1928 redraw!
1929 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
1930 call assert_equal(" ï¼¶ abcde", s:ScreenLine(2, 1, 9))
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001931
1932 sign unplace * group=*
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001933 sign undefine sign1
1934 set signcolumn&
1935 set number&
1936 enew! | close
1937endfunc
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001938
1939" Test for managing multiple signs using the sign functions
1940func Test_sign_funcs_multi()
Bram Moolenaar56564962022-10-10 22:39:42 +01001941 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001942 edit Xsign
1943 let bnum = bufnr('')
1944
1945 " Define multiple signs at once
1946 call assert_equal([0, 0, 0, 0], sign_define([
1947 \ {'name' : 'sign1', 'text' : '=>', 'linehl' : 'Search',
1948 \ 'texthl' : 'Search'},
1949 \ {'name' : 'sign2', 'text' : '=>', 'linehl' : 'Search',
1950 \ 'texthl' : 'Search'},
1951 \ {'name' : 'sign3', 'text' : '=>', 'linehl' : 'Search',
1952 \ 'texthl' : 'Search'},
1953 \ {'name' : 'sign4', 'text' : '=>', 'linehl' : 'Search',
1954 \ 'texthl' : 'Search'}]))
1955
1956 " Negative cases for sign_define()
1957 call assert_equal([], sign_define([]))
1958 call assert_equal([-1], sign_define([{}]))
1959 call assert_fails('call sign_define([6])', 'E715:')
1960 call assert_fails('call sign_define(["abc"])', 'E715:')
1961 call assert_fails('call sign_define([[]])', 'E715:')
1962
1963 " Place multiple signs at once with specific sign identifier
1964 let l = sign_placelist([{'id' : 1, 'group' : 'g1', 'name' : 'sign1',
1965 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 50},
1966 \ {'id' : 2, 'group' : 'g2', 'name' : 'sign2',
1967 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 100},
1968 \ {'id' : 3, 'group' : '', 'name' : 'sign3',
1969 \ 'buffer' : 'Xsign', 'lnum' : 11}])
1970 call assert_equal([1, 2, 3], l)
1971 let s = sign_getplaced('Xsign', {'group' : '*'})
1972 call assert_equal([
1973 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11,
1974 \ 'group' : 'g2', 'priority' : 100},
1975 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1976 \ 'group' : 'g1', 'priority' : 50},
1977 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11,
1978 \ 'group' : '', 'priority' : 10}], s[0].signs)
1979
1980 call sign_unplace('*')
1981
1982 " Place multiple signs at once with auto-generated sign identifier
1983 call assert_equal([1, 1, 5], sign_placelist([
1984 \ {'group' : 'g1', 'name' : 'sign1',
1985 \ 'buffer' : 'Xsign', 'lnum' : 11},
1986 \ {'group' : 'g2', 'name' : 'sign2',
1987 \ 'buffer' : 'Xsign', 'lnum' : 11},
1988 \ {'group' : '', 'name' : 'sign3',
1989 \ 'buffer' : 'Xsign', 'lnum' : 11}]))
1990 let s = sign_getplaced('Xsign', {'group' : '*'})
1991 call assert_equal([
1992 \ {'id' : 5, 'name' : 'sign3', 'lnum' : 11,
1993 \ 'group' : '', 'priority' : 10},
1994 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 11,
1995 \ 'group' : 'g2', 'priority' : 10},
1996 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1997 \ 'group' : 'g1', 'priority' : 10}], s[0].signs)
1998
1999 " Change an existing sign without specifying the group
Bram Moolenaar93476fd2019-09-06 22:00:54 +02002000 call assert_equal([5], [{'id' : 5, 'name' : 'sign1', 'buffer' : 'Xsign'}]->sign_placelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002001 let s = sign_getplaced('Xsign', {'id' : 5, 'group' : ''})
2002 call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
2003 \ 'group' : '', 'priority' : 10}], s[0].signs)
2004
Bram Moolenaar42aff462019-08-21 13:20:29 +02002005 " Place a sign using '.' as the line number
2006 call cursor(23, 1)
2007 call assert_equal([7], sign_placelist([
2008 \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
2009 let s = sign_getplaced('%', {'lnum' : '.'})
2010 call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
2011 \ 'group' : '', 'priority' : 10}], s[0].signs)
2012
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002013 " Place sign without a sign name
2014 call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
2015 \ 'lnum' : 12, 'group' : ''}]))
2016
2017 " Place sign without a buffer
2018 call assert_equal([-1], sign_placelist([{'id' : 10, 'name' : 'sign1',
2019 \ 'lnum' : 12, 'group' : ''}]))
2020
2021 " Invalid arguments
2022 call assert_equal([], sign_placelist([]))
Bram Moolenaard83392a2022-09-01 12:22:46 +01002023 call assert_fails('call sign_placelist({})', "E1211:")
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002024 call assert_fails('call sign_placelist([[]])', "E715:")
2025 call assert_fails('call sign_placelist(["abc"])', "E715:")
2026 call assert_fails('call sign_placelist([100])', "E715:")
2027
2028 " Unplace multiple signs
2029 call assert_equal([0, 0, 0], sign_unplacelist([{'id' : 5},
2030 \ {'id' : 1, 'group' : 'g1'}, {'id' : 1, 'group' : 'g2'}]))
2031
2032 " Invalid arguments
Bram Moolenaar93476fd2019-09-06 22:00:54 +02002033 call assert_equal([], []->sign_unplacelist())
Bram Moolenaard83392a2022-09-01 12:22:46 +01002034 call assert_fails('call sign_unplacelist({})', "E1211:")
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002035 call assert_fails('call sign_unplacelist([[]])', "E715:")
2036 call assert_fails('call sign_unplacelist(["abc"])', "E715:")
2037 call assert_fails('call sign_unplacelist([100])', "E715:")
Bram Moolenaare2e40752020-09-04 21:18:46 +02002038 call assert_fails("call sign_unplacelist([{'id' : -1}])", 'E474:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002039
2040 call assert_equal([0, 0, 0, 0],
2041 \ sign_undefine(['sign1', 'sign2', 'sign3', 'sign4']))
2042 call assert_equal([], sign_getdefined())
2043
2044 " Invalid arguments
2045 call assert_equal([], sign_undefine([]))
2046 call assert_fails('call sign_undefine([[]])', 'E730:')
2047 call assert_fails('call sign_undefine([{}])', 'E731:')
2048 call assert_fails('call sign_undefine(["1abc2"])', 'E155:')
2049
2050 call sign_unplace('*')
2051 call sign_undefine()
2052 enew!
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002053endfunc
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002054
Bram Moolenaar5c56da42021-08-28 14:42:25 +02002055func Test_sign_null_list()
2056 eval test_null_list()->sign_define()
2057 eval test_null_list()->sign_placelist()
2058 eval test_null_list()->sign_undefine()
2059 eval test_null_list()->sign_unplacelist()
2060endfunc
2061
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002062" vim: shiftwidth=2 sts=2 expandtab