blob: 7f53d62daf339b1a095878aad6c727ed1b11351c [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:')
Luuk van Baale670d172023-11-19 10:55:35 +0100197
198 " Defining a sign without attributes is allowed.
199 sign define Sign1
200 call assert_equal([{'name': 'Sign1'}], sign_getdefined())
201 sign undefine Sign1
Bram Moolenaar446a9732016-08-10 21:36:23 +0200202endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200203
Bram Moolenaar2b1ddf12022-09-21 11:21:57 +0100204func Test_sign_many_bytes()
205 new
206 set signcolumn=number
207 set number
208 call setline(1, 'some text')
209 " composing characters can use many bytes, check for overflow
210 sign define manyBytes text=▶᷄᷅᷆◀᷄᷅᷆᷇
211 sign place 17 line=1 name=manyBytes
212 redraw
213
214 bwipe!
215 sign undefine manyBytes
216endfunc
217
Bram Moolenaar446a9732016-08-10 21:36:23 +0200218" Undefining placed sign is not recommended.
219" Quoting :help sign
220"
221" :sign undefine {name}
222" Deletes a previously defined sign. If signs with this {name}
223" are still placed this will cause trouble.
224func Test_sign_undefine_still_placed()
225 new foobar
226 sign define Sign text=x
227 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
228 sign undefine Sign
229
230 " Listing placed sign should show that sign is deleted.
231 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100232 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100233 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200234
235 sign unplace 41
236 let a=execute('sign place')
237 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200238endfunc
239
240func Test_sign_completion()
241 sign define Sign1 text=x
242 sign define Sign2 text=y
243
244 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
245 call assert_equal('"sign define jump list place undefine unplace', @:)
246
247 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
LemonBoyb975ddf2024-07-06 18:04:09 +0200248 call assert_equal('"sign define Sign culhl= icon= linehl= numhl= priority= text= texthl=', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200249
James McCoya80aad72021-12-22 19:45:28 +0000250 for hl in ['culhl', 'linehl', 'numhl', 'texthl']
251 call feedkeys(":sign define Sign "..hl.."=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
252 call assert_equal('"sign define Sign '..hl..'=SpellBad SpellCap ' .
253 \ 'SpellLocal SpellRare', @:)
254 endfor
Bram Moolenaar3678f652019-02-17 14:50:25 +0100255
Bram Moolenaar56564962022-10-10 22:39:42 +0100256 call writefile(repeat(["Sun is shining"], 30), "XsignOne", 'D')
257 call writefile(repeat(["Sky is blue"], 30), "XsignTwo", 'D')
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200258 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
259 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200260
Bram Moolenaar3678f652019-02-17 14:50:25 +0100261 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200262 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
263 call assert_equal('"sign undefine Sign1 Sign2', @:)
264
265 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100266 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
267 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200268
269 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
270 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
271
Bram Moolenaar3678f652019-02-17 14:50:25 +0100272 edit XsignOne
273 sign place 1 name=Sign1 line=5
274 sign place 1 name=Sign1 group=g1 line=10
275 edit XsignTwo
276 sign place 1 name=Sign2 group=g2 line=15
277
278 " Test for completion of group= and file= arguments to ':sign place'
279 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
280 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
281 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
282 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
283
284 " Test for completion of arguments to 'sign place' without sign identifier
285 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
286 call assert_equal('"sign place buffer= file= group=', @:)
287 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
288 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
289 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
290 call assert_equal('"sign place group=g1 g2', @:)
291 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
292 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
293
294 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200295 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100296 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100297 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
298 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
299 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
300 call assert_equal('"sign unplace 1 group=g1 g2', @:)
301 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
302 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200303
Bram Moolenaar3678f652019-02-17 14:50:25 +0100304 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200305 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
306 call assert_equal('"sign list Sign1 Sign2', @:)
307
Bram Moolenaar3678f652019-02-17 14:50:25 +0100308 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200309 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100310 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100311 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
312 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
313 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
314 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200315
Bram Moolenaar3678f652019-02-17 14:50:25 +0100316 " Error cases
317 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
318 call assert_equal('"sign here', @:)
319 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
320 call assert_equal("\"sign define Sign here=\<C-A>", @:)
321 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
322 call assert_equal("\"sign place 1 here=\<C-A>", @:)
323 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
324 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
325 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
326 call assert_equal("\"sign here there\<C-A>", @:)
327 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
328 call assert_equal("\"sign here there=\<C-A>", @:)
329
330 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200331 sign undefine Sign1
332 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100333 enew
Bram Moolenaar09de1752016-08-08 22:26:48 +0200334endfunc
335
336func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100337 sign define Sign1 text=x
338
Bram Moolenaar09de1752016-08-08 22:26:48 +0200339 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200340 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200341 call assert_fails('sign xxx', 'E160:')
342 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200343 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200344 call assert_fails('sign undefine', 'E156:')
345 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200346 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100347 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
348 call assert_fails('sign place buffer=999', 'E158:')
349 call assert_fails('sign jump buffer=999', 'E158:')
350 call assert_fails('sign jump 1 file=', 'E158:')
351 call assert_fails('sign jump 1 group=', 'E474:')
352 call assert_fails('sign jump 1 name=', 'E474:')
353 call assert_fails('sign jump 1 name=Sign1', 'E474:')
354 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200355 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100356 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100357 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
358 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100359 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100360 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
361 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100362 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100363 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
364 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100365 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100366 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
367 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100368 " Sign identifier and '*' for :sign unplace
369 call assert_fails("sign unplace 2 *", 'E474:')
370 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100371 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
372 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100373 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100374 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
375 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100376 call assert_fails("sign unplace 1 xxx", 'E474:')
377 call assert_fails("sign unplace * xxx", 'E474:')
378 call assert_fails("sign unplace xxx", 'E474:')
379 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100380 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100381 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100382 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100383 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100384 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100385 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100386 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100387 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100388 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100389 " Placing a sign with only sign identifier
390 call assert_fails("sign place 2", 'E474:')
391 " Placing a sign with only a name
392 call assert_fails("sign place abc", 'E474:')
393 " Placing a sign with only line number
394 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100395 " Placing a sign with only sign group
396 call assert_fails("sign place 5 group=g1", 'E474:')
397 call assert_fails("sign place 5 group=*", 'E474:')
398 " Placing a sign with only sign priority
399 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100400
401 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200402endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200403
404func Test_sign_delete_buffer()
405 new
406 sign define Sign text=x
407 let bufnr = bufnr('%')
408 new
409 exe 'bd ' . bufnr
410 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
411 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
412 sign unplace 61
413 sign undefine Sign
414endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100415
Bram Moolenaard933c822019-08-21 13:45:16 +0200416" Ignore error: E255: Couldn't read in sign data!
417" This error can happen when running in the GUI.
418" Some gui like Motif do not support the png icon format.
419func Sign_command_ignore_error(cmd)
420 try
421 exe a:cmd
422 catch /E255:/
423 endtry
424endfunc
425
426" ignore error: E255: Couldn't read in sign data!
427" This error can happen when running in gui.
428func Sign_define_ignore_error(name, attr)
429 try
430 call sign_define(a:name, a:attr)
431 catch /E255:/
432 endtry
433endfunc
434
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100435" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100436func Test_sign_funcs()
437 " Remove all the signs
438 call sign_unplace('*')
439 call sign_undefine()
440
441 " Tests for sign_define()
Bram Moolenaare413ea02021-11-24 16:20:13 +0000442 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error',
James McCoya80aad72021-12-22 19:45:28 +0000443 \ 'culhl': 'Visual', 'numhl': 'Number'}
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200444 call assert_equal(0, "sign1"->sign_define(attr))
James McCoya80aad72021-12-22 19:45:28 +0000445 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error', 'linehl' : 'Search',
446 \ 'culhl' : 'Visual', 'numhl': 'Number', 'text' : '=>'}],
Bram Moolenaare413ea02021-11-24 16:20:13 +0000447 \ sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100448
449 " Define a new sign without attributes and then update it
450 call sign_define("sign2")
451 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
James McCoya80aad72021-12-22 19:45:28 +0000452 \ 'culhl': 'DiffDelete', 'numhl': 'Number', 'icon' : 'sign2.ico'}
Bram Moolenaard933c822019-08-21 13:45:16 +0200453 call Sign_define_ignore_error("sign2", attr)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100454 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000455 \ 'linehl' : 'DiffAdd', 'culhl' : 'DiffDelete', 'text' : '!!',
James McCoya80aad72021-12-22 19:45:28 +0000456 \ 'numhl': 'Number', 'icon' : 'sign2.ico'}],
457 \ "sign2"->sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100458
459 " Test for a sign name with digits
460 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
461 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
462 \ sign_getdefined(0002))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200463 eval 0002->sign_undefine()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100464
465 " Tests for invalid arguments to sign_define()
466 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
467 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200468 call assert_fails('call sign_define({})', 'E731:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100469 call assert_fails('call sign_define("sign6", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100470
471 " Tests for sign_getdefined()
472 call assert_equal([], sign_getdefined("none"))
473 call assert_fails('call sign_getdefined({})', 'E731:')
474
475 " Tests for sign_place()
Bram Moolenaar56564962022-10-10 22:39:42 +0100476 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100477 edit Xsign
478
479 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
480 \ {'lnum' : 20}))
481 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
482 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
483 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
484 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
485 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
486 \ 'priority' : 10}]}],
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200487 \ '%'->sign_getplaced({'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100488 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
489 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
490 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100491 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100492
493 " Tests for invalid arguments to sign_place()
494 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
495 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100496 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100497 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
498 \ {"lnum" : 30})', 'E474:')
499 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
500 \ {"lnum" : 30})', 'E155:')
501 call assert_fails('call sign_place(10, "", "", "Xsign",
502 \ {"lnum" : 30})', 'E155:')
503 call assert_fails('call sign_place(10, "", [], "Xsign",
504 \ {"lnum" : 30})', 'E730:')
505 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
506 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100507 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100508 \ 'E158:')
509 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200510 \ 'E730:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100511 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200512 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100513 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200514 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100515 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200516 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100517 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
518
519 " Tests for sign_getplaced()
520 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
521 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
522 \ 'priority' : 10}]}],
523 \ sign_getplaced(bufnr('Xsign')))
524 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
525 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
526 \ 'priority' : 10}]}],
527 \ sign_getplaced())
528 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100529 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100530 call assert_fails('call sign_getplaced(-1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100531 call assert_fails('call sign_getplaced("Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100532 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
533 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
534 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
535 \ 'E745:')
536 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
537 \ sign_getplaced('Xsign', {'id' : 44}))
538 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
539 \ 'E745:')
540
541 " Tests for sign_unplace()
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200542 eval 20->sign_place('', 'sign2', 'Xsign', {"lnum" : 30})
Bram Moolenaar162b7142018-12-21 15:17:36 +0100543 call assert_equal(0, sign_unplace('',
544 \ {'id' : 20, 'buffer' : 'Xsign'}))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200545 call assert_equal(-1, ''->sign_unplace(
Bram Moolenaar162b7142018-12-21 15:17:36 +0100546 \ {'id' : 30, 'buffer' : 'Xsign'}))
547 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
548 call assert_fails("call sign_unplace('',
549 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
550 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100551 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100552 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100553 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100554 call assert_fails("call sign_unplace('g1', 'mySign')", 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100555
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200556 call sign_unplace('*')
557
558 " Test for modifying a placed sign
559 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
560 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
561 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
562 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
563 \ 'priority' : 10}]}],
564 \ sign_getplaced())
565
Bram Moolenaar162b7142018-12-21 15:17:36 +0100566 " Tests for sign_undefine()
567 call assert_equal(0, sign_undefine("sign1"))
568 call assert_equal([], sign_getdefined("sign1"))
569 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200570 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100571
Bram Moolenaar42aff462019-08-21 13:20:29 +0200572 " Test for using '.' as the line number for sign_place()
Bram Moolenaard933c822019-08-21 13:45:16 +0200573 call Sign_define_ignore_error("sign1", attr)
Bram Moolenaar42aff462019-08-21 13:20:29 +0200574 call cursor(22, 1)
575 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
576 \ {'lnum' : '.'}))
577 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
578 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
579 \ 'priority' : 10}]}],
580 \ sign_getplaced('%', {'lnum' : 22}))
581
Bram Moolenaar162b7142018-12-21 15:17:36 +0100582 call sign_unplace('*')
583 call sign_undefine()
584 enew | only
585endfunc
586
587" Tests for sign groups
588func Test_sign_group()
589 enew | only
590 " Remove all the signs
591 call sign_unplace('*')
592 call sign_undefine()
593
Bram Moolenaar56564962022-10-10 22:39:42 +0100594 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100595
596 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
597 call assert_equal(0, sign_define("sign1", attr))
598
599 edit Xsign
600 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100601
602 " Error case
603 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
604 \ {'lnum' : 30})", 'E730:')
605
606 " place three signs with the same identifier. One in the global group and
607 " others in the named groups
608 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
609 \ {'lnum' : 10}))
610 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
611 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
612
613 " Test for sign_getplaced() with group
614 let s = sign_getplaced('Xsign')
615 call assert_equal(1, len(s[0].signs))
616 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100617 let s = sign_getplaced(bnum, {'group' : ''})
618 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
619 \ 'priority' : 10}], s[0].signs)
620 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100621 let s = sign_getplaced(bnum, {'group' : 'g2'})
622 call assert_equal('g2', s[0].signs[0].group)
623 let s = sign_getplaced(bnum, {'group' : 'g3'})
624 call assert_equal([], s[0].signs)
625 let s = sign_getplaced(bnum, {'group' : '*'})
626 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
627 \ 'priority' : 10},
628 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
629 \ 'priority' : 10},
630 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
631 \ 'priority' : 10}],
632 \ s[0].signs)
633
634 " Test for sign_getplaced() with id
635 let s = sign_getplaced(bnum, {'id' : 5})
636 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
637 \ 'priority' : 10}],
638 \ s[0].signs)
639 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
640 call assert_equal(
641 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
642 \ 'priority' : 10}],
643 \ s[0].signs)
644 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
645 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
646 \ 'priority' : 10},
647 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
648 \ 'priority' : 10},
649 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
650 \ 'priority' : 10}],
651 \ s[0].signs)
652 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
653 call assert_equal([], s[0].signs)
654
655 " Test for sign_getplaced() with lnum
656 let s = sign_getplaced(bnum, {'lnum' : 20})
657 call assert_equal([], s[0].signs)
658 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
659 call assert_equal(
660 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
661 \ 'priority' : 10}],
662 \ s[0].signs)
663 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
664 call assert_equal(
665 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
666 \ 'priority' : 10}],
667 \ s[0].signs)
668 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
669 call assert_equal([], s[0].signs)
670
671 " Error case
672 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
673 \ 'E730:')
674
675 " Clear the sign in global group
676 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
677 let s = sign_getplaced(bnum, {'group' : '*'})
678 call assert_equal([
679 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
680 \ 'priority' : 10},
681 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
682 \ 'priority' : 10}],
683 \ s[0].signs)
684
685 " Clear the sign in one of the groups
686 call sign_unplace('g1', {'buffer' : 'Xsign'})
687 let s = sign_getplaced(bnum, {'group' : '*'})
688 call assert_equal([
689 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
690 \ 'priority' : 10}],
691 \ s[0].signs)
692
693 " Clear all the signs from the buffer
694 call sign_unplace('*', {'buffer' : bnum})
695 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
696
697 " Clear sign across groups using an identifier
698 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
699 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
700 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
701 call assert_equal(0, sign_unplace('*', {'id' : 25}))
702 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
703
704 " Error case
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +0100705 call assert_fails("call sign_unplace({})", 'E1174:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100706
707 " Place a sign in the global group and try to delete it using a group
708 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
709 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
710
711 " Place signs in multiple groups and delete all the signs in one of the
712 " group
713 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
714 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
715 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
716 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
717 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
718 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
719 call assert_equal(0, sign_unplace('g1'))
720 let s = sign_getplaced(bnum, {'group' : 'g1'})
721 call assert_equal([], s[0].signs)
722 let s = sign_getplaced(bnum)
723 call assert_equal(2, len(s[0].signs))
724 let s = sign_getplaced(bnum, {'group' : 'g2'})
725 call assert_equal('g2', s[0].signs[0].group)
726 call assert_equal(0, sign_unplace('', {'id' : 5}))
727 call assert_equal(0, sign_unplace('', {'id' : 6}))
728 let s = sign_getplaced(bnum, {'group' : 'g2'})
729 call assert_equal('g2', s[0].signs[0].group)
730 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
731
732 call sign_unplace('*')
733
734 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100735 sign place 5 line=10 name=sign1 file=Xsign
736 sign place 5 group=g1 line=10 name=sign1 file=Xsign
737 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100738
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100739 " Tests for the ':sign place' command
740
741 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100742 let a = execute('sign place 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 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={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100747 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +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", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100750
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100751 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100752 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100753 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100754 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
755 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
756 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100757
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100758 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100759 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100760 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
761
762 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100763 let bnum = bufnr('Xsign')
764 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
765 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
766 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
767
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100768 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100769 let a = execute('sign place 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=10 id=5 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={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100774 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100775 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100776 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100777
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100778 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100779 let a = execute('sign place group=* buffer=' . bnum)
780 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100781 \ " line=10 id=5 name=sign1 priority=10\n" .
782 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
783 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100784
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100785 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100786 let a = execute('sign place group=xyz buffer=' . bnum)
787 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
788
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100789 " :sign place
790 let a = execute('sign place')
791 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100792 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100793
Bram Moolenaarb589f952019-01-07 22:10:00 +0100794 " Place signs in more than one buffer and list the signs
795 split foo
796 set buftype=nofile
797 sign place 25 line=76 name=sign1 priority=99 file=foo
798 let a = execute('sign place')
799 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
800 \ " line=10 id=5 name=sign1 priority=10\n" .
801 \ "Signs for foo:\n" .
802 \ " line=76 id=25 name=sign1 priority=99\n", a)
803 close
804 bwipe foo
805
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100806 " :sign place group={group}
807 let a = execute('sign place group=g1')
808 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100809 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100810
811 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100812 let a = execute('sign place group=*')
813 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100814 \ " line=10 id=5 name=sign1 priority=10\n" .
815 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
816 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100817
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100818 " Test for ':sign jump' command with groups
819 sign jump 5 group=g1 file=Xsign
820 call assert_equal(11, line('.'))
821 call assert_equal('Xsign', bufname(''))
822 sign jump 5 group=g2 file=Xsign
823 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100824
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100825 " Test for :sign jump command without the filename or buffer
826 sign jump 5
827 call assert_equal(10, line('.'))
828 sign jump 5 group=g1
829 call assert_equal(11, line('.'))
830
Bram Moolenaar162b7142018-12-21 15:17:36 +0100831 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100832 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100833
Bram Moolenaar162b7142018-12-21 15:17:36 +0100834 call sign_unplace('*')
835 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100836 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100837endfunc
838
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100839" Place signs used for ":sign unplace" command test
840func Place_signs_for_test()
841 call sign_unplace('*')
842
843 sign place 3 line=10 name=sign1 file=Xsign1
844 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
845 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
846 sign place 4 line=15 name=sign1 file=Xsign1
847 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
848 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
849 sign place 5 line=20 name=sign1 file=Xsign2
850 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
851 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
852 sign place 6 line=25 name=sign1 file=Xsign2
853 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
854 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
855endfunc
856
857" Place multiple signs in a single line for test
858func Place_signs_at_line_for_test()
859 call sign_unplace('*')
860 sign place 3 line=13 name=sign1 file=Xsign1
861 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
862 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
863 sign place 4 line=13 name=sign1 file=Xsign1
864 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
865 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
866endfunc
867
868" Tests for the ':sign unplace' command
869func Test_sign_unplace()
870 enew | only
871 " Remove all the signs
872 call sign_unplace('*')
873 call sign_undefine()
874
875 " Create two files and define signs
Bram Moolenaar56564962022-10-10 22:39:42 +0100876 call writefile(repeat(["Sun is shining"], 30), "Xsign1", 'D')
877 call writefile(repeat(["It is beautiful"], 30), "Xsign2", 'D')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100878
879 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
880 call sign_define("sign1", attr)
881
882 edit Xsign1
883 let bnum1 = bufnr('%')
884 split Xsign2
885 let bnum2 = bufnr('%')
886
887 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
888 \ 'priority' : 10},
889 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
890 \ 'priority' : 10},
891 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
892 \ 'priority' : 10},
893 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
894 \ 'priority' : 10},
895 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
896 \ 'priority' : 10},
897 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
898 \ 'priority' : 10},]
899 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
900 \ 'priority' : 10},
901 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
902 \ 'priority' : 10},
903 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
904 \ 'priority' : 10},
905 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
906 \ 'priority' : 10},
907 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
908 \ 'priority' : 10},
909 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
910 \ 'priority' : 10},]
911
912 " Test for :sign unplace {id} file={fname}
913 call Place_signs_for_test()
914 sign unplace 3 file=Xsign1
915 sign unplace 6 file=Xsign2
916 call assert_equal(
917 \ filter(copy(signs1),
918 \ {idx, val -> val.id != 3 || val.group != ''}),
919 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
920 call assert_equal(
921 \ filter(copy(signs2),
922 \ {idx, val -> val.id != 6 || val.group != ''}),
923 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
924
925 " Test for :sign unplace {id} group={group} file={fname}
926 call Place_signs_for_test()
927 sign unplace 4 group=g1 file=Xsign1
928 sign unplace 5 group=g2 file=Xsign2
929 call assert_equal(
930 \ filter(copy(signs1),
931 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
932 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
933 call assert_equal(
934 \ filter(copy(signs2),
935 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
936 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
937
938 " Test for :sign unplace {id} group=* file={fname}
939 call Place_signs_for_test()
940 sign unplace 3 group=* file=Xsign1
941 sign unplace 6 group=* file=Xsign2
942 call assert_equal(
943 \ filter(copy(signs1),
944 \ {idx, val -> val.id != 3}),
945 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
946 call assert_equal(
947 \ filter(copy(signs2),
948 \ {idx, val -> val.id != 6}),
949 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
950
951 " Test for :sign unplace * file={fname}
952 call Place_signs_for_test()
953 sign unplace * file=Xsign1
954 call assert_equal(
955 \ filter(copy(signs1),
956 \ {idx, val -> val.group != ''}),
957 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
958 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
959
960 " Test for :sign unplace * group={group} file={fname}
961 call Place_signs_for_test()
962 sign unplace * group=g1 file=Xsign1
963 sign unplace * group=g2 file=Xsign2
964 call assert_equal(
965 \ filter(copy(signs1),
966 \ {idx, val -> val.group != 'g1'}),
967 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
968 call assert_equal(
969 \ filter(copy(signs2),
970 \ {idx, val -> val.group != 'g2'}),
971 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
972
973 " Test for :sign unplace * group=* file={fname}
974 call Place_signs_for_test()
975 sign unplace * group=* file=Xsign2
976 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
977 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
978
979 " Test for :sign unplace {id} buffer={nr}
980 call Place_signs_for_test()
981 exe 'sign unplace 3 buffer=' . bnum1
982 exe 'sign unplace 6 buffer=' . bnum2
983 call assert_equal(
984 \ filter(copy(signs1),
985 \ {idx, val -> val.id != 3 || val.group != ''}),
986 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
987 call assert_equal(
988 \ filter(copy(signs2),
989 \ {idx, val -> val.id != 6 || val.group != ''}),
990 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
991
992 " Test for :sign unplace {id} group={group} buffer={nr}
993 call Place_signs_for_test()
994 exe 'sign unplace 4 group=g1 buffer=' . bnum1
995 exe 'sign unplace 5 group=g2 buffer=' . bnum2
996 call assert_equal(
997 \ filter(copy(signs1),
998 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
999 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1000 call assert_equal(
1001 \ filter(copy(signs2),
1002 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
1003 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1004
1005 " Test for :sign unplace {id} group=* buffer={nr}
1006 call Place_signs_for_test()
1007 exe 'sign unplace 3 group=* buffer=' . bnum1
1008 exe 'sign unplace 6 group=* buffer=' . bnum2
1009 call assert_equal(
1010 \ filter(copy(signs1),
1011 \ {idx, val -> val.id != 3}),
1012 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1013 call assert_equal(
1014 \ filter(copy(signs2),
1015 \ {idx, val -> val.id != 6}),
1016 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1017
1018 " Test for :sign unplace * buffer={nr}
1019 call Place_signs_for_test()
1020 exe 'sign unplace * buffer=' . bnum1
1021 call assert_equal(
1022 \ filter(copy(signs1),
1023 \ {idx, val -> val.group != ''}),
1024 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1025 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1026
1027 " Test for :sign unplace * group={group} buffer={nr}
1028 call Place_signs_for_test()
1029 exe 'sign unplace * group=g1 buffer=' . bnum1
1030 exe 'sign unplace * group=g2 buffer=' . bnum2
1031 call assert_equal(
1032 \ filter(copy(signs1),
1033 \ {idx, val -> val.group != 'g1'}),
1034 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1035 call assert_equal(
1036 \ filter(copy(signs2),
1037 \ {idx, val -> val.group != 'g2'}),
1038 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1039
1040 " Test for :sign unplace * group=* buffer={nr}
1041 call Place_signs_for_test()
1042 exe 'sign unplace * group=* buffer=' . bnum2
1043 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1044 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1045
1046 " Test for :sign unplace {id}
1047 call Place_signs_for_test()
1048 sign unplace 4
1049 sign unplace 6
1050 call assert_equal(
1051 \ filter(copy(signs1),
1052 \ {idx, val -> val.id != 4 || val.group != ''}),
1053 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1054 call assert_equal(
1055 \ filter(copy(signs2),
1056 \ {idx, val -> val.id != 6 || val.group != ''}),
1057 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1058
1059 " Test for :sign unplace {id} group={group}
1060 call Place_signs_for_test()
1061 sign unplace 4 group=g1
1062 sign unplace 6 group=g2
1063 call assert_equal(
1064 \ filter(copy(signs1),
1065 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1066 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1067 call assert_equal(
1068 \ filter(copy(signs2),
1069 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1070 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1071
1072 " Test for :sign unplace {id} group=*
1073 call Place_signs_for_test()
1074 sign unplace 3 group=*
1075 sign unplace 5 group=*
1076 call assert_equal(
1077 \ filter(copy(signs1),
1078 \ {idx, val -> val.id != 3}),
1079 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1080 call assert_equal(
1081 \ filter(copy(signs2),
1082 \ {idx, val -> val.id != 5}),
1083 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1084
1085 " Test for :sign unplace *
1086 call Place_signs_for_test()
1087 sign unplace *
1088 call assert_equal(
1089 \ filter(copy(signs1),
1090 \ {idx, val -> val.group != ''}),
1091 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1092 call assert_equal(
1093 \ filter(copy(signs2),
1094 \ {idx, val -> val.group != ''}),
1095 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1096
1097 " Test for :sign unplace * group={group}
1098 call Place_signs_for_test()
1099 sign unplace * group=g1
1100 call assert_equal(
1101 \ filter(copy(signs1),
1102 \ {idx, val -> val.group != 'g1'}),
1103 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1104 call assert_equal(
1105 \ filter(copy(signs2),
1106 \ {idx, val -> val.group != 'g1'}),
1107 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1108
1109 " Test for :sign unplace * group=*
1110 call Place_signs_for_test()
1111 sign unplace * group=*
1112 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1113 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1114
1115 " Negative test cases
1116 call Place_signs_for_test()
1117 sign unplace 3 group=xy file=Xsign1
1118 sign unplace * group=xy file=Xsign1
1119 silent! sign unplace * group=* file=FileNotPresent
1120 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1121 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1122
1123 " Tests for removing sign at the current cursor position
1124
1125 " Test for ':sign unplace'
1126 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1127 \ 'priority' : 10},
1128 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1129 \ 'priority' : 10},
1130 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1131 \ 'priority' : 10},
1132 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1133 \ 'priority' : 10},
1134 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1135 \ 'priority' : 10},
1136 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1137 \ 'priority' : 10},]
1138 exe bufwinnr('Xsign1') . 'wincmd w'
1139 call cursor(13, 1)
1140
1141 " Should remove only one sign in the global group
1142 call Place_signs_at_line_for_test()
1143 sign unplace
1144 call assert_equal(
1145 \ filter(copy(signs1),
1146 \ {idx, val -> val.id != 4 || val.group != ''}),
1147 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1148 " Should remove the second sign in the global group
1149 sign unplace
1150 call assert_equal(
1151 \ filter(copy(signs1),
1152 \ {idx, val -> val.group != ''}),
1153 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1154
1155 " Test for ':sign unplace group={group}'
1156 call Place_signs_at_line_for_test()
1157 " Should remove only one sign in group g1
1158 sign unplace group=g1
1159 call assert_equal(
1160 \ filter(copy(signs1),
1161 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1162 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1163 sign unplace group=g2
1164 call assert_equal(
1165 \ filter(copy(signs1),
1166 \ {idx, val -> val.id != 4 || val.group == ''}),
1167 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1168
1169 " Test for ':sign unplace group=*'
1170 call Place_signs_at_line_for_test()
1171 sign unplace group=*
1172 sign unplace group=*
1173 sign unplace group=*
1174 call assert_equal(
1175 \ filter(copy(signs1),
1176 \ {idx, val -> val.id != 4}),
1177 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1178 sign unplace group=*
1179 sign unplace group=*
1180 sign unplace group=*
1181 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1182
1183 call sign_unplace('*')
1184 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001185 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001186endfunc
1187
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001188" Tests for auto-generating the sign identifier.
1189func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001190 enew | only
1191 call sign_unplace('*')
1192 call sign_undefine()
1193
1194 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1195 call assert_equal(0, sign_define("sign1", attr))
1196
Bram Moolenaar56564962022-10-10 22:39:42 +01001197 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001198 edit Xsign
1199
1200 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1201 \ {'lnum' : 10}))
1202 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1203 \ {'lnum' : 12}))
1204 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1205 \ {'lnum' : 14}))
1206 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001207 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001208 \ {'lnum' : 12}))
1209
1210 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1211 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001212 " Check for the next generated sign id in this group
1213 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1214 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001215 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1216 call assert_equal(10,
1217 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1218
Bram Moolenaar162b7142018-12-21 15:17:36 +01001219 call sign_unplace('*')
1220 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001221 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001222endfunc
1223
1224" Test for sign priority
1225func Test_sign_priority()
1226 enew | only
1227 call sign_unplace('*')
1228 call sign_undefine()
1229
1230 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1231 call sign_define("sign1", attr)
1232 call sign_define("sign2", attr)
1233 call sign_define("sign3", attr)
LemonBoyb975ddf2024-07-06 18:04:09 +02001234 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search', 'priority': 60}
1235 call sign_define("sign4", attr)
1236
1237 " Test for :sign list
1238 let a = execute('sign list')
1239 call assert_equal("\nsign sign1 text==> linehl=Search texthl=Search\n" .
1240 \ "sign sign2 text==> linehl=Search texthl=Search\n" .
1241 \ "sign sign3 text==> linehl=Search texthl=Search\n" .
1242 \ "sign sign4 text==> priority=60 linehl=Search texthl=Search", a)
1243
1244 " Test for sign_getdefined()
1245 let s = sign_getdefined()
1246 call assert_equal([
1247 \ {'name': 'sign1', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1248 \ {'name': 'sign2', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1249 \ {'name': 'sign3', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1250 \ {'name': 'sign4', 'priority': 60, 'texthl': 'Search', 'linehl': 'Search',
1251 \ 'text': '=>'}],
1252 \ s)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001253
1254 " Place three signs with different priority in the same line
Bram Moolenaar56564962022-10-10 22:39:42 +01001255 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001256 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001257
1258 call sign_place(1, 'g1', 'sign1', 'Xsign',
1259 \ {'lnum' : 11, 'priority' : 50})
1260 call sign_place(2, 'g2', 'sign2', 'Xsign',
1261 \ {'lnum' : 11, 'priority' : 100})
1262 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1263 let s = sign_getplaced('Xsign', {'group' : '*'})
1264 call assert_equal([
1265 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1266 \ 'priority' : 100},
1267 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1268 \ 'priority' : 50},
1269 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1270 \ 'priority' : 10}],
1271 \ s[0].signs)
1272
Bram Moolenaar64416122019-06-07 21:37:13 +02001273 call sign_unplace('*')
1274
1275 " Three signs on different lines with changing priorities
1276 call sign_place(1, '', 'sign1', 'Xsign',
1277 \ {'lnum' : 11, 'priority' : 50})
1278 call sign_place(2, '', 'sign2', 'Xsign',
1279 \ {'lnum' : 12, 'priority' : 60})
1280 call sign_place(3, '', 'sign3', 'Xsign',
1281 \ {'lnum' : 13, 'priority' : 70})
1282 call sign_place(2, '', 'sign2', 'Xsign',
1283 \ {'lnum' : 12, 'priority' : 40})
1284 call sign_place(3, '', 'sign3', 'Xsign',
1285 \ {'lnum' : 13, 'priority' : 30})
1286 call sign_place(1, '', 'sign1', 'Xsign',
1287 \ {'lnum' : 11, 'priority' : 50})
1288 let s = sign_getplaced('Xsign', {'group' : '*'})
1289 call assert_equal([
1290 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1291 \ 'priority' : 50},
1292 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1293 \ 'priority' : 40},
1294 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1295 \ 'priority' : 30}],
1296 \ s[0].signs)
1297
1298 call sign_unplace('*')
1299
1300 " Two signs on the same line with changing priorities
1301 call sign_place(1, '', 'sign1', 'Xsign',
1302 \ {'lnum' : 4, 'priority' : 20})
1303 call sign_place(2, '', 'sign2', 'Xsign',
1304 \ {'lnum' : 4, 'priority' : 30})
1305 let s = sign_getplaced('Xsign', {'group' : '*'})
1306 call assert_equal([
1307 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1308 \ 'priority' : 30},
1309 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1310 \ 'priority' : 20}],
1311 \ s[0].signs)
1312 " Change the priority of the last sign to highest
1313 call sign_place(1, '', 'sign1', 'Xsign',
1314 \ {'lnum' : 4, 'priority' : 40})
1315 let s = sign_getplaced('Xsign', {'group' : '*'})
1316 call assert_equal([
1317 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1318 \ 'priority' : 40},
1319 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1320 \ 'priority' : 30}],
1321 \ s[0].signs)
1322 " Change the priority of the first sign to lowest
1323 call sign_place(1, '', 'sign1', 'Xsign',
1324 \ {'lnum' : 4, 'priority' : 25})
1325 let s = sign_getplaced('Xsign', {'group' : '*'})
1326 call assert_equal([
1327 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1328 \ 'priority' : 30},
1329 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1330 \ 'priority' : 25}],
1331 \ s[0].signs)
1332 call sign_place(1, '', 'sign1', 'Xsign',
1333 \ {'lnum' : 4, 'priority' : 45})
1334 call sign_place(2, '', 'sign2', 'Xsign',
1335 \ {'lnum' : 4, 'priority' : 55})
1336 let s = sign_getplaced('Xsign', {'group' : '*'})
1337 call assert_equal([
1338 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1339 \ 'priority' : 55},
1340 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1341 \ 'priority' : 45}],
1342 \ s[0].signs)
1343
1344 call sign_unplace('*')
1345
1346 " Three signs on the same line with changing priorities
1347 call sign_place(1, '', 'sign1', 'Xsign',
1348 \ {'lnum' : 4, 'priority' : 40})
1349 call sign_place(2, '', 'sign2', 'Xsign',
1350 \ {'lnum' : 4, 'priority' : 30})
1351 call sign_place(3, '', 'sign3', 'Xsign',
1352 \ {'lnum' : 4, 'priority' : 20})
1353 let s = sign_getplaced('Xsign', {'group' : '*'})
1354 call assert_equal([
1355 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1356 \ 'priority' : 40},
1357 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1358 \ 'priority' : 30},
1359 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1360 \ 'priority' : 20}],
1361 \ s[0].signs)
1362
1363 " Change the priority of the middle sign to the highest
1364 call sign_place(2, '', 'sign2', 'Xsign',
1365 \ {'lnum' : 4, 'priority' : 50})
1366 let s = sign_getplaced('Xsign', {'group' : '*'})
1367 call assert_equal([
1368 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1369 \ 'priority' : 50},
1370 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1371 \ 'priority' : 40},
1372 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1373 \ 'priority' : 20}],
1374 \ s[0].signs)
1375
1376 " Change the priority of the middle sign to the lowest
1377 call sign_place(1, '', 'sign1', 'Xsign',
1378 \ {'lnum' : 4, 'priority' : 15})
1379 let s = sign_getplaced('Xsign', {'group' : '*'})
1380 call assert_equal([
1381 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1382 \ 'priority' : 50},
1383 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1384 \ 'priority' : 20},
1385 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1386 \ 'priority' : 15}],
1387 \ s[0].signs)
1388
1389 " Change the priority of the last sign to the highest
1390 call sign_place(1, '', 'sign1', 'Xsign',
1391 \ {'lnum' : 4, 'priority' : 55})
1392 let s = sign_getplaced('Xsign', {'group' : '*'})
1393 call assert_equal([
1394 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1395 \ 'priority' : 55},
1396 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1397 \ 'priority' : 50},
1398 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1399 \ 'priority' : 20}],
1400 \ s[0].signs)
1401
1402 " Change the priority of the first sign to the lowest
1403 call sign_place(1, '', 'sign1', 'Xsign',
1404 \ {'lnum' : 4, 'priority' : 15})
1405 let s = sign_getplaced('Xsign', {'group' : '*'})
1406 call assert_equal([
1407 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1408 \ 'priority' : 50},
1409 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1410 \ 'priority' : 20},
1411 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1412 \ 'priority' : 15}],
1413 \ s[0].signs)
1414
1415 call sign_unplace('*')
1416
1417 " Three signs on the same line with changing priorities along with other
1418 " signs
1419 call sign_place(1, '', 'sign1', 'Xsign',
1420 \ {'lnum' : 2, 'priority' : 10})
1421 call sign_place(2, '', 'sign1', 'Xsign',
1422 \ {'lnum' : 4, 'priority' : 30})
1423 call sign_place(3, '', 'sign2', 'Xsign',
1424 \ {'lnum' : 4, 'priority' : 20})
1425 call sign_place(4, '', 'sign3', 'Xsign',
1426 \ {'lnum' : 4, 'priority' : 25})
1427 call sign_place(5, '', 'sign2', 'Xsign',
1428 \ {'lnum' : 6, 'priority' : 80})
1429 let s = sign_getplaced('Xsign', {'group' : '*'})
1430 call assert_equal([
1431 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1432 \ 'priority' : 10},
1433 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1434 \ 'priority' : 30},
1435 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1436 \ 'priority' : 25},
1437 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1438 \ 'priority' : 20},
1439 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1440 \ 'priority' : 80}],
1441 \ s[0].signs)
1442
1443 " Change the priority of the first sign to lowest
1444 call sign_place(2, '', 'sign1', 'Xsign',
1445 \ {'lnum' : 4, 'priority' : 15})
1446 let s = sign_getplaced('Xsign', {'group' : '*'})
1447 call assert_equal([
1448 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1449 \ 'priority' : 10},
1450 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1451 \ 'priority' : 25},
1452 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1453 \ 'priority' : 20},
1454 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1455 \ 'priority' : 15},
1456 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1457 \ 'priority' : 80}],
1458 \ s[0].signs)
1459
1460 " Change the priority of the last sign to highest
1461 call sign_place(2, '', 'sign1', 'Xsign',
1462 \ {'lnum' : 4, 'priority' : 30})
1463 let s = sign_getplaced('Xsign', {'group' : '*'})
1464 call assert_equal([
1465 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1466 \ 'priority' : 10},
1467 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1468 \ 'priority' : 30},
1469 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1470 \ 'priority' : 25},
1471 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1472 \ 'priority' : 20},
1473 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1474 \ 'priority' : 80}],
1475 \ s[0].signs)
1476
1477 " Change the priority of the middle sign to lowest
1478 call sign_place(4, '', 'sign3', 'Xsign',
1479 \ {'lnum' : 4, 'priority' : 15})
1480 let s = sign_getplaced('Xsign', {'group' : '*'})
1481 call assert_equal([
1482 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1483 \ 'priority' : 10},
1484 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1485 \ 'priority' : 30},
1486 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1487 \ 'priority' : 20},
1488 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1489 \ 'priority' : 15},
1490 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1491 \ 'priority' : 80}],
1492 \ s[0].signs)
1493
1494 " Change the priority of the middle sign to highest
1495 call sign_place(3, '', 'sign2', 'Xsign',
1496 \ {'lnum' : 4, 'priority' : 35})
1497 let s = sign_getplaced('Xsign', {'group' : '*'})
1498 call assert_equal([
1499 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1500 \ 'priority' : 10},
1501 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1502 \ 'priority' : 35},
1503 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1504 \ 'priority' : 30},
1505 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1506 \ 'priority' : 15},
1507 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1508 \ 'priority' : 80}],
1509 \ s[0].signs)
1510
1511 call sign_unplace('*')
1512
1513 " Multiple signs with the same priority on the same line
1514 call sign_place(1, '', 'sign1', 'Xsign',
1515 \ {'lnum' : 4, 'priority' : 20})
1516 call sign_place(2, '', 'sign2', 'Xsign',
1517 \ {'lnum' : 4, 'priority' : 20})
1518 call sign_place(3, '', 'sign3', 'Xsign',
1519 \ {'lnum' : 4, 'priority' : 20})
1520 let s = sign_getplaced('Xsign', {'group' : '*'})
1521 call assert_equal([
1522 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1523 \ 'priority' : 20},
1524 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1525 \ 'priority' : 20},
1526 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1527 \ 'priority' : 20}],
1528 \ s[0].signs)
1529 " Place the last sign again with the same priority
1530 call sign_place(1, '', 'sign1', 'Xsign',
1531 \ {'lnum' : 4, 'priority' : 20})
1532 let s = sign_getplaced('Xsign', {'group' : '*'})
1533 call assert_equal([
1534 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1535 \ 'priority' : 20},
1536 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1537 \ 'priority' : 20},
1538 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1539 \ 'priority' : 20}],
1540 \ s[0].signs)
1541 " Place the first sign again with the same priority
1542 call sign_place(1, '', 'sign1', 'Xsign',
1543 \ {'lnum' : 4, 'priority' : 20})
1544 let s = sign_getplaced('Xsign', {'group' : '*'})
1545 call assert_equal([
1546 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1547 \ 'priority' : 20},
1548 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1549 \ 'priority' : 20},
1550 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1551 \ 'priority' : 20}],
1552 \ s[0].signs)
1553 " Place the middle sign again with the same priority
1554 call sign_place(3, '', 'sign3', 'Xsign',
1555 \ {'lnum' : 4, 'priority' : 20})
1556 let s = sign_getplaced('Xsign', {'group' : '*'})
1557 call assert_equal([
1558 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1559 \ 'priority' : 20},
1560 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1561 \ 'priority' : 20},
1562 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1563 \ 'priority' : 20}],
1564 \ s[0].signs)
1565
1566 call sign_unplace('*')
1567
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001568 " Place multiple signs with same id on a line with different priority
1569 call sign_place(1, '', 'sign1', 'Xsign',
1570 \ {'lnum' : 5, 'priority' : 20})
1571 call sign_place(1, '', 'sign2', 'Xsign',
1572 \ {'lnum' : 5, 'priority' : 10})
1573 let s = sign_getplaced('Xsign', {'lnum' : 5})
1574 call assert_equal([
1575 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1576 \ 'priority' : 10}],
1577 \ s[0].signs)
1578 call sign_place(1, '', 'sign2', 'Xsign',
1579 \ {'lnum' : 5, 'priority' : 5})
1580 let s = sign_getplaced('Xsign', {'lnum' : 5})
1581 call assert_equal([
1582 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1583 \ 'priority' : 5}],
1584 \ s[0].signs)
1585
Bram Moolenaar162b7142018-12-21 15:17:36 +01001586 " Error case
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001587 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign', [])", 'E1206:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001588 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1589 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001590 call sign_unplace('*')
1591
1592 " Tests for the :sign place command with priority
1593 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1594 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1595 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1596 let a = execute('sign place group=*')
1597 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001598 \ " line=10 id=5 name=sign1 priority=30\n" .
1599 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1600 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001601
1602 " Test for :sign place group={group}
1603 let a = execute('sign place group=g1')
1604 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001605 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001606
1607 call sign_unplace('*')
LemonBoyb975ddf2024-07-06 18:04:09 +02001608
1609 " Test for sign with default priority.
1610 call sign_place(1, 'g1', 'sign4', 'Xsign', {'lnum' : 3})
1611 sign place 2 line=5 name=sign4 group=g1 file=Xsign
1612
1613 let s = sign_getplaced('Xsign', {'group' : '*'})
1614 call assert_equal([
1615 \ {'id' : 1, 'name' : 'sign4', 'lnum' : 3, 'group' : 'g1',
1616 \ 'priority' : 60},
1617 \ {'id' : 2, 'name' : 'sign4', 'lnum' : 5, 'group' : 'g1',
1618 \ 'priority' : 60}],
1619 \ s[0].signs)
1620
1621 let a = execute('sign place group=g1')
1622 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1623 \ " line=3 id=1 group=g1 name=sign4 priority=60\n" .
1624 \ " line=5 id=2 group=g1 name=sign4 priority=60\n", a)
1625
1626 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001627 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001628 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001629endfunc
1630
1631" Tests for memory allocation failures in sign functions
1632func Test_sign_memfailures()
Bram Moolenaar56564962022-10-10 22:39:42 +01001633 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001634 edit Xsign
1635
1636 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1637 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1638 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1639 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1640 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1641 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1642 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1643
1644 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1645 call sign_define("sign1", attr)
1646 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1647 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1648
1649 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1650 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1651 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1652 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1653 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1654
1655 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1656 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1657 \ 'E342:')
1658
1659 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1660 call assert_fails('call getbufinfo()', 'E342:')
1661 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1662 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1663 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1664 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1665 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1666
1667 call sign_unplace('*')
1668 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001669 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001670endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001671
1672" Test for auto-adjusting the line number of a placed sign.
1673func Test_sign_lnum_adjust()
1674 enew! | only!
1675
1676 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001677 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001678 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1679 let l = sign_getplaced(bufnr(''))
1680 call assert_equal(3, l[0].signs[0].lnum)
1681
1682 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001683 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001684 let l = sign_getplaced(bufnr(''))
1685 call assert_equal(6, l[0].signs[0].lnum)
1686
1687 " Delete some lines before the sign and check the sign line number
1688 call deletebufline('%', 1, 2)
1689 let l = sign_getplaced(bufnr(''))
1690 call assert_equal(4, l[0].signs[0].lnum)
1691
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001692 " Insert some lines after the sign and check the sign line number
1693 call append(5, ['DA', 'DB'])
1694 let l = sign_getplaced(bufnr(''))
1695 call assert_equal(4, l[0].signs[0].lnum)
1696
1697 " Delete some lines after the sign and check the sign line number
1698 call deletebufline('', 6, 7)
1699 let l = sign_getplaced(bufnr(''))
1700 call assert_equal(4, l[0].signs[0].lnum)
1701
1702 " Break the undo. Otherwise the undo operation below will undo all the
1703 " changes made by this function.
Christian Brabandt6efb1982023-08-10 05:44:25 +02001704 let &g:undolevels=&g:undolevels
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001705
1706 " Delete the line with the sign
1707 call deletebufline('', 4)
1708 let l = sign_getplaced(bufnr(''))
1709 call assert_equal(4, l[0].signs[0].lnum)
1710
1711 " Undo the delete operation
1712 undo
1713 let l = sign_getplaced(bufnr(''))
1714 call assert_equal(5, l[0].signs[0].lnum)
1715
1716 " Break the undo
Christian Brabandt6efb1982023-08-10 05:44:25 +02001717 let &g:undolevels=&g:undolevels
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001718
1719 " Delete few lines at the end of the buffer including the line with the sign
1720 " Sign line number should not change (as it is placed outside of the buffer)
1721 call deletebufline('', 3, 6)
1722 let l = sign_getplaced(bufnr(''))
1723 call assert_equal(5, l[0].signs[0].lnum)
1724
1725 " Undo the delete operation. Sign should be restored to the previous line
1726 undo
1727 let l = sign_getplaced(bufnr(''))
1728 call assert_equal(5, l[0].signs[0].lnum)
1729
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001730 sign unplace * group=*
1731 sign undefine sign1
1732 enew!
1733endfunc
1734
1735" Test for changing the type of a placed sign
1736func Test_sign_change_type()
1737 enew! | only!
1738
1739 sign define sign1 text=#> linehl=Comment
1740 sign define sign2 text=@@ linehl=Comment
1741
1742 call setline(1, ['A', 'B', 'C', 'D'])
1743 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1744 let l = sign_getplaced(bufnr(''))
1745 call assert_equal('sign1', l[0].signs[0].name)
1746 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1747 let l = sign_getplaced(bufnr(''))
1748 call assert_equal('sign2', l[0].signs[0].name)
1749 call sign_place(4, '', 'sign1', '')
1750 let l = sign_getplaced(bufnr(''))
1751 call assert_equal('sign1', l[0].signs[0].name)
1752
1753 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1754 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1755 call assert_equal('sign1', l[0].signs[0].name)
1756 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1757 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1758 call assert_equal('sign2', l[0].signs[0].name)
1759 call sign_place(4, 'g1', 'sign1', '')
1760 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1761 call assert_equal('sign1', l[0].signs[0].name)
1762
1763 sign unplace * group=*
1764 sign undefine sign1
1765 sign undefine sign2
1766 enew!
1767endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001768
1769" Test for the sign_jump() function
1770func Test_sign_jump_func()
1771 enew! | only!
1772
1773 sign define sign1 text=#> linehl=Comment
1774
1775 edit foo
1776 set buftype=nofile
1777 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1778 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1779 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1780 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1781 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1782 split bar
1783 set buftype=nofile
1784 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1785 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1786 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1787 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1788 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1789
1790 let r = sign_jump(5, '', 'foo')
1791 call assert_equal(2, r)
1792 call assert_equal(2, line('.'))
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001793 let r = 6->sign_jump('g1', 'foo')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001794 call assert_equal(5, r)
1795 call assert_equal(5, line('.'))
1796 let r = sign_jump(5, '', 'bar')
1797 call assert_equal(2, r)
1798 call assert_equal(2, line('.'))
1799
1800 " Error cases
1801 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1802 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1803 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1804 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1805 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001806 call assert_fails('call sign_jump(2, "", {})', 'E731:')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001807 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1808
1809 sign unplace * group=*
1810 sign undefine sign1
1811 enew! | only!
1812endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001813
1814" Test for correct cursor position after the sign column appears or disappears.
1815func Test_sign_cursor_position()
Bram Moolenaar494e9062020-05-31 21:28:02 +02001816 CheckRunVimInTerminal
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001817
1818 let lines =<< trim END
1819 call setline(1, [repeat('x', 75), 'mmmm', 'yyyy'])
1820 call cursor(2,1)
Bram Moolenaar94722c52023-01-28 19:19:03 +00001821 sign define s1 texthl=Search text==>
1822 sign define s2 linehl=Pmenu
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001823 redraw
Bram Moolenaar94722c52023-01-28 19:19:03 +00001824 sign place 10 line=2 name=s1
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001825 END
Bram Moolenaar56564962022-10-10 22:39:42 +01001826 call writefile(lines, 'XtestSigncolumn', 'D')
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001827 let buf = RunVimInTerminal('-S XtestSigncolumn', {'rows': 6})
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001828 call VerifyScreenDump(buf, 'Test_sign_cursor_1', {})
1829
1830 " Change the sign text
1831 call term_sendkeys(buf, ":sign define s1 text=-)\<CR>")
1832 call VerifyScreenDump(buf, 'Test_sign_cursor_2', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001833
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001834 " Also place a line HL sign
1835 call term_sendkeys(buf, ":sign place 11 line=2 name=s2\<CR>")
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001836 call VerifyScreenDump(buf, 'Test_sign_cursor_3', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001837
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001838 " update cursor position calculation
1839 call term_sendkeys(buf, "lh")
1840 call term_sendkeys(buf, ":sign unplace 11\<CR>")
1841 call term_sendkeys(buf, ":sign unplace 10\<CR>")
1842 call VerifyScreenDump(buf, 'Test_sign_cursor_4', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001843
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001844 " 'cursorline' highlighting overrules sign
1845 call term_sendkeys(buf, ":sign place 12 line=2 name=s2\<CR>")
1846 call term_sendkeys(buf, ":set cursorline\<CR>")
1847 call term_sendkeys(buf, ":hi CursorLine ctermbg=Green\<CR>")
1848 call term_sendkeys(buf, "2G")
1849 call term_sendkeys(buf, ":\<CR>")
1850 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
zeertzjqb7acea12022-12-12 13:20:43 +00001851 call term_sendkeys(buf, ":set cursorlineopt=number,screenline\<CR>")
1852 call term_sendkeys(buf, ":\<CR>")
1853 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001854
1855 " sign highlighting overrules 'cursorline'
1856 call term_sendkeys(buf, ":sign unplace 12\<CR>")
1857 call term_sendkeys(buf, ":sign place 13 line=2 priority=100 name=s2\<CR>")
1858 call term_sendkeys(buf, ":\<CR>")
1859 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
zeertzjqb7acea12022-12-12 13:20:43 +00001860 call term_sendkeys(buf, ":set cursorlineopt&\<CR>")
1861 call term_sendkeys(buf, ":\<CR>")
1862 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001863
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001864 " clean up
1865 call StopVimInTerminal(buf)
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001866endfunc
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001867
1868" Return the 'len' characters in screen starting from (row,col)
1869func s:ScreenLine(row, col, len)
1870 let s = ''
1871 for i in range(a:len)
1872 let s .= nr2char(screenchar(a:row, a:col + i))
1873 endfor
1874 return s
1875endfunc
1876
1877" Test for 'signcolumn' set to 'number'.
1878func Test_sign_numcol()
1879 new
1880 call append(0, "01234")
1881 " With 'signcolumn' set to 'number', make sure sign is displayed in the
1882 " number column and line number is not displayed.
1883 set numberwidth=2
1884 set number
1885 set signcolumn=number
1886 sign define sign1 text==>
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001887 sign define sign2 text=V
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001888 sign place 10 line=1 name=sign1
1889 redraw!
1890 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1891
1892 " With 'signcolumn' set to 'number', when there is no sign, make sure line
1893 " number is displayed in the number column
1894 sign unplace 10
1895 redraw!
1896 call assert_equal("1 01234", s:ScreenLine(1, 1, 7))
1897
1898 " Disable number column. Check whether sign is displayed in the sign column
1899 set numberwidth=4
1900 set nonumber
1901 sign place 10 line=1 name=sign1
1902 redraw!
1903 call assert_equal("=>01234", s:ScreenLine(1, 1, 7))
1904
1905 " Enable number column. Check whether sign is displayed in the number column
1906 set number
1907 redraw!
Bram Moolenaar4dff4ae2019-06-19 16:31:28 +02001908 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001909
1910 " Disable sign column. Make sure line number is displayed
1911 set signcolumn=no
1912 redraw!
1913 call assert_equal(" 1 01234", s:ScreenLine(1, 1, 9))
1914
1915 " Enable auto sign column. Make sure both sign and line number are displayed
1916 set signcolumn=auto
1917 redraw!
1918 call assert_equal("=> 1 01234", s:ScreenLine(1, 1, 11))
1919
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001920 " Test displaying signs in the number column with width 1
1921 call sign_unplace('*')
1922 call append(1, "abcde")
1923 call append(2, "01234")
1924 " Enable number column with width 1
1925 set number numberwidth=1 signcolumn=auto
1926 redraw!
1927 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1928 " Place a sign and make sure number column width remains the same
1929 sign place 20 line=2 name=sign1
1930 redraw!
1931 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1932 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1933 " Set 'signcolumn' to 'number', make sure the number column width increases
1934 set signcolumn=number
1935 redraw!
1936 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1937 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1938 " Set 'signcolumn' to 'auto', make sure the number column width is 1.
1939 set signcolumn=auto
1940 redraw!
1941 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1942 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1943 " Set 'signcolumn' to 'number', make sure the number column width is 2.
1944 set signcolumn=number
1945 redraw!
1946 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1947 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1948 " Disable 'number' column
1949 set nonumber
1950 redraw!
1951 call assert_equal("=>abcde", s:ScreenLine(2, 1, 7))
1952 call assert_equal(" 01234", s:ScreenLine(3, 1, 7))
1953 " Enable 'number' column
1954 set number
1955 redraw!
1956 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1957 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1958 " Remove the sign and make sure the width of the number column is 1.
1959 call sign_unplace('', {'id' : 20})
1960 redraw!
1961 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1962 " When the first sign is placed with 'signcolumn' set to number, verify that
1963 " the number column width increases
1964 sign place 30 line=1 name=sign1
1965 redraw!
1966 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1967 call assert_equal(" 2 abcde", s:ScreenLine(2, 1, 8))
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001968 " Add sign with multi-byte text
1969 set numberwidth=4
1970 sign place 40 line=2 name=sign2
1971 redraw!
1972 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
1973 call assert_equal(" V abcde", s:ScreenLine(2, 1, 9))
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001974
1975 sign unplace * group=*
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001976 sign undefine sign1
1977 set signcolumn&
1978 set number&
1979 enew! | close
1980endfunc
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001981
1982" Test for managing multiple signs using the sign functions
1983func Test_sign_funcs_multi()
Bram Moolenaar56564962022-10-10 22:39:42 +01001984 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001985 edit Xsign
1986 let bnum = bufnr('')
1987
1988 " Define multiple signs at once
1989 call assert_equal([0, 0, 0, 0], sign_define([
1990 \ {'name' : 'sign1', 'text' : '=>', 'linehl' : 'Search',
1991 \ 'texthl' : 'Search'},
1992 \ {'name' : 'sign2', 'text' : '=>', 'linehl' : 'Search',
1993 \ 'texthl' : 'Search'},
1994 \ {'name' : 'sign3', 'text' : '=>', 'linehl' : 'Search',
1995 \ 'texthl' : 'Search'},
1996 \ {'name' : 'sign4', 'text' : '=>', 'linehl' : 'Search',
1997 \ 'texthl' : 'Search'}]))
1998
1999 " Negative cases for sign_define()
2000 call assert_equal([], sign_define([]))
2001 call assert_equal([-1], sign_define([{}]))
2002 call assert_fails('call sign_define([6])', 'E715:')
2003 call assert_fails('call sign_define(["abc"])', 'E715:')
2004 call assert_fails('call sign_define([[]])', 'E715:')
2005
2006 " Place multiple signs at once with specific sign identifier
2007 let l = sign_placelist([{'id' : 1, 'group' : 'g1', 'name' : 'sign1',
2008 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 50},
2009 \ {'id' : 2, 'group' : 'g2', 'name' : 'sign2',
2010 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 100},
2011 \ {'id' : 3, 'group' : '', 'name' : 'sign3',
2012 \ 'buffer' : 'Xsign', 'lnum' : 11}])
2013 call assert_equal([1, 2, 3], l)
2014 let s = sign_getplaced('Xsign', {'group' : '*'})
2015 call assert_equal([
2016 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11,
2017 \ 'group' : 'g2', 'priority' : 100},
2018 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
2019 \ 'group' : 'g1', 'priority' : 50},
2020 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11,
2021 \ 'group' : '', 'priority' : 10}], s[0].signs)
2022
2023 call sign_unplace('*')
2024
2025 " Place multiple signs at once with auto-generated sign identifier
2026 call assert_equal([1, 1, 5], sign_placelist([
2027 \ {'group' : 'g1', 'name' : 'sign1',
2028 \ 'buffer' : 'Xsign', 'lnum' : 11},
2029 \ {'group' : 'g2', 'name' : 'sign2',
2030 \ 'buffer' : 'Xsign', 'lnum' : 11},
2031 \ {'group' : '', 'name' : 'sign3',
2032 \ 'buffer' : 'Xsign', 'lnum' : 11}]))
2033 let s = sign_getplaced('Xsign', {'group' : '*'})
2034 call assert_equal([
2035 \ {'id' : 5, 'name' : 'sign3', 'lnum' : 11,
2036 \ 'group' : '', 'priority' : 10},
2037 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 11,
2038 \ 'group' : 'g2', 'priority' : 10},
2039 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
2040 \ 'group' : 'g1', 'priority' : 10}], s[0].signs)
2041
2042 " Change an existing sign without specifying the group
Bram Moolenaar93476fd2019-09-06 22:00:54 +02002043 call assert_equal([5], [{'id' : 5, 'name' : 'sign1', 'buffer' : 'Xsign'}]->sign_placelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002044 let s = sign_getplaced('Xsign', {'id' : 5, 'group' : ''})
2045 call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
2046 \ 'group' : '', 'priority' : 10}], s[0].signs)
2047
Bram Moolenaar42aff462019-08-21 13:20:29 +02002048 " Place a sign using '.' as the line number
2049 call cursor(23, 1)
2050 call assert_equal([7], sign_placelist([
2051 \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
2052 let s = sign_getplaced('%', {'lnum' : '.'})
2053 call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
2054 \ 'group' : '', 'priority' : 10}], s[0].signs)
2055
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002056 " Place sign without a sign name
2057 call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
2058 \ 'lnum' : 12, 'group' : ''}]))
2059
2060 " Place sign without a buffer
2061 call assert_equal([-1], sign_placelist([{'id' : 10, 'name' : 'sign1',
2062 \ 'lnum' : 12, 'group' : ''}]))
2063
2064 " Invalid arguments
2065 call assert_equal([], sign_placelist([]))
Bram Moolenaard83392a2022-09-01 12:22:46 +01002066 call assert_fails('call sign_placelist({})', "E1211:")
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002067 call assert_fails('call sign_placelist([[]])', "E715:")
2068 call assert_fails('call sign_placelist(["abc"])', "E715:")
2069 call assert_fails('call sign_placelist([100])', "E715:")
2070
2071 " Unplace multiple signs
2072 call assert_equal([0, 0, 0], sign_unplacelist([{'id' : 5},
2073 \ {'id' : 1, 'group' : 'g1'}, {'id' : 1, 'group' : 'g2'}]))
2074
2075 " Invalid arguments
Bram Moolenaar93476fd2019-09-06 22:00:54 +02002076 call assert_equal([], []->sign_unplacelist())
Bram Moolenaard83392a2022-09-01 12:22:46 +01002077 call assert_fails('call sign_unplacelist({})', "E1211:")
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002078 call assert_fails('call sign_unplacelist([[]])', "E715:")
2079 call assert_fails('call sign_unplacelist(["abc"])', "E715:")
2080 call assert_fails('call sign_unplacelist([100])', "E715:")
Bram Moolenaare2e40752020-09-04 21:18:46 +02002081 call assert_fails("call sign_unplacelist([{'id' : -1}])", 'E474:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002082
2083 call assert_equal([0, 0, 0, 0],
2084 \ sign_undefine(['sign1', 'sign2', 'sign3', 'sign4']))
2085 call assert_equal([], sign_getdefined())
2086
2087 " Invalid arguments
2088 call assert_equal([], sign_undefine([]))
2089 call assert_fails('call sign_undefine([[]])', 'E730:')
2090 call assert_fails('call sign_undefine([{}])', 'E731:')
2091 call assert_fails('call sign_undefine(["1abc2"])', 'E155:')
2092
2093 call sign_unplace('*')
2094 call sign_undefine()
2095 enew!
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002096endfunc
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002097
Bram Moolenaar5c56da42021-08-28 14:42:25 +02002098func Test_sign_null_list()
2099 eval test_null_list()->sign_define()
2100 eval test_null_list()->sign_placelist()
2101 eval test_null_list()->sign_undefine()
2102 eval test_null_list()->sign_unplacelist()
2103endfunc
2104
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002105" vim: shiftwidth=2 sts=2 expandtab