blob: 83cfc5f2f1ab6375a7cacbc4bb024c02859dd638 [file] [log] [blame]
Bram Moolenaar09de1752016-08-08 22:26:48 +02001" Test for signs
2
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02003CheckFeature signs
Bram Moolenaar09de1752016-08-08 22:26:48 +02004
Christian Brabandteb380b92025-07-07 20:53:55 +02005source util/screendump.vim
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02006
Bram Moolenaar09de1752016-08-08 22:26:48 +02007func Test_sign()
8 new
9 call setline(1, ['a', 'b', 'c', 'd'])
10
Bram Moolenaar446a9732016-08-10 21:36:23 +020011 " Define some signs.
12 " We can specify icons even if not all versions of vim support icons as
13 " icon is ignored when not supported. "(not supported)" is shown after
14 " the icon name when listing signs.
Bram Moolenaar09de1752016-08-08 22:26:48 +020015 sign define Sign1 text=x
Bram Moolenaard933c822019-08-21 13:45:16 +020016
James McCoya80aad72021-12-22 19:45:28 +000017 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 +020018
19 " Test listing signs.
20 let a=execute('sign list')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010021 call assert_match('^\nsign Sign1 text=x \nsign Sign2 ' .
22 \ 'icon=../../pixmaps/stock_vim_find_help.png .*text=xy ' .
James McCoya80aad72021-12-22 19:45:28 +000023 \ 'linehl=Error texthl=Title culhl=Search numhl=Number$', a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020024
25 let a=execute('sign list Sign1')
26 call assert_equal("\nsign Sign1 text=x ", a)
27
Bram Moolenaar7d83bf42018-12-29 18:53:55 +010028 " Split the window to the bottom to verify sign jump will stay in the
29 " current window if the buffer is displayed there.
Bram Moolenaar446a9732016-08-10 21:36:23 +020030 let bn = bufnr('%')
31 let wn = winnr()
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010032 exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
Bram Moolenaar09de1752016-08-08 22:26:48 +020033 1
Bram Moolenaar446a9732016-08-10 21:36:23 +020034 bot split
35 exe 'sign jump 41 buffer=' . bufnr('%')
36 call assert_equal('c', getline('.'))
37 call assert_equal(3, winnr())
38 call assert_equal(bn, bufnr('%'))
39 call assert_notequal(wn, winnr())
40
41 " Create a new buffer and check that ":sign jump" switches to the old buffer.
42 1
43 new foo
44 call assert_notequal(bn, bufnr('%'))
45 exe 'sign jump 41 buffer=' . bn
46 call assert_equal(bn, bufnr('%'))
Bram Moolenaar09de1752016-08-08 22:26:48 +020047 call assert_equal('c', getline('.'))
48
Bram Moolenaar446a9732016-08-10 21:36:23 +020049 " Redraw to make sure that screen redraw with sign gets exercised,
50 " with and without 'rightleft'.
51 if has('rightleft')
52 set rightleft
53 redraw
54 set norightleft
55 endif
56 redraw
Bram Moolenaar09de1752016-08-08 22:26:48 +020057
Bram Moolenaar446a9732016-08-10 21:36:23 +020058 " Check that we can't change sign.
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010059 call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
Bram Moolenaar446a9732016-08-10 21:36:23 +020060
61 " Check placed signs
Bram Moolenaar09de1752016-08-08 22:26:48 +020062 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010063 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010064 \ " line=3 id=41 name=Sign1 priority=10\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020065
Bram Moolenaar446a9732016-08-10 21:36:23 +020066 " Unplace the sign and try jumping to it again should fail.
67 sign unplace 41
Bram Moolenaar09de1752016-08-08 22:26:48 +020068 1
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010069 call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
Bram Moolenaar09de1752016-08-08 22:26:48 +020070 call assert_equal('a', getline('.'))
71
72 " Unplace sign on current line.
Bram Moolenaar446a9732016-08-10 21:36:23 +020073 exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020074 4
75 sign unplace
76 let a=execute('sign place')
77 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010078
Bram Moolenaar09de1752016-08-08 22:26:48 +020079 " Try again to unplace sign on current line, it should fail this time.
80 call assert_fails('sign unplace', 'E159:')
81
82 " Unplace all signs.
Bram Moolenaar446a9732016-08-10 21:36:23 +020083 exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020084 sign unplace *
85 let a=execute('sign place')
86 call assert_equal("\n--- Signs ---\n", a)
87
Bram Moolenaarb328cca2019-01-06 16:24:01 +010088 " Place a sign without specifying the filename or buffer
89 sign place 77 line=9 name=Sign2
90 let a=execute('sign place')
91 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010092 \ " line=9 id=77 name=Sign2 priority=10\n", a)
Bram Moolenaarb328cca2019-01-06 16:24:01 +010093 sign unplace *
94
Bram Moolenaar446a9732016-08-10 21:36:23 +020095 " Check :jump with file=...
96 edit foo
97 call setline(1, ['A', 'B', 'C', 'D'])
98
Bram Moolenaard933c822019-08-21 13:45:16 +020099 call Sign_command_ignore_error('sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist icon=doesnotexist.xpm')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200100
101 let fn = expand('%:p')
102 exe 'sign place 43 line=2 name=Sign3 file=' . fn
103 edit bar
104 call assert_notequal(fn, expand('%:p'))
105 exe 'sign jump 43 file=' . fn
106 call assert_equal('B', getline('.'))
107
Bram Moolenaara3556522018-12-31 22:02:29 +0100108 " Check for jumping to a sign in a hidden buffer
109 enew! | only!
110 edit foo
111 call setline(1, ['A', 'B', 'C', 'D'])
112 let fn = expand('%:p')
113 exe 'sign place 21 line=3 name=Sign3 file=' . fn
114 hide edit bar
115 exe 'sign jump 21 file=' . fn
116 call assert_equal('C', getline('.'))
117
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100118 " can't define a sign with a non-printable character as text
119 call assert_fails("sign define Sign4 text=\e linehl=Comment", 'E239:')
120 call assert_fails("sign define Sign4 text=a\e linehl=Comment", 'E239:')
121 call assert_fails("sign define Sign4 text=\ea linehl=Comment", 'E239:')
122
123 " Only 1 or 2 character text is allowed
124 call assert_fails("sign define Sign4 text=abc linehl=Comment", 'E239:')
125 call assert_fails("sign define Sign4 text= linehl=Comment", 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100126 call assert_fails("sign define Sign4 text=\\ ab linehl=Comment", 'E239:')
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100127
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000128 " an empty highlight argument for an existing sign clears it
James McCoya80aad72021-12-22 19:45:28 +0000129 sign define SignY texthl=TextHl culhl=CulHl linehl=LineHl numhl=NumHl
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000130 let sl = sign_getdefined('SignY')[0]
131 call assert_equal('TextHl', sl.texthl)
132 call assert_equal('CulHl', sl.culhl)
133 call assert_equal('LineHl', sl.linehl)
James McCoya80aad72021-12-22 19:45:28 +0000134 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000135
James McCoya80aad72021-12-22 19:45:28 +0000136 sign define SignY texthl= culhl=CulHl linehl=LineHl numhl=NumHl
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000137 let sl = sign_getdefined('SignY')[0]
138 call assert_false(has_key(sl, 'texthl'))
139 call assert_equal('CulHl', sl.culhl)
140 call assert_equal('LineHl', sl.linehl)
James McCoya80aad72021-12-22 19:45:28 +0000141 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000142
143 sign define SignY linehl=
144 let sl = sign_getdefined('SignY')[0]
145 call assert_false(has_key(sl, 'linehl'))
146 call assert_equal('CulHl', sl.culhl)
James McCoya80aad72021-12-22 19:45:28 +0000147 call assert_equal('NumHl', sl.numhl)
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000148
149 sign define SignY culhl=
150 let sl = sign_getdefined('SignY')[0]
151 call assert_false(has_key(sl, 'culhl'))
James McCoya80aad72021-12-22 19:45:28 +0000152 call assert_equal('NumHl', sl.numhl)
153
154 sign define SignY numhl=
155 let sl = sign_getdefined('SignY')[0]
156 call assert_false(has_key(sl, 'numhl'))
Bram Moolenaar0bac5fc2021-12-05 17:45:49 +0000157
158 sign undefine SignY
Bram Moolenaar5e18ccc2021-12-05 13:02:50 +0000159
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100160 " define sign with whitespace
161 sign define Sign4 text=\ X linehl=Comment
162 sign undefine Sign4
163 sign define Sign4 linehl=Comment text=\ X
164 sign undefine Sign4
165
166 sign define Sign5 text=X\ linehl=Comment
167 sign undefine Sign5
168 sign define Sign5 linehl=Comment text=X\
169 sign undefine Sign5
170
171 " define sign with backslash
172 sign define Sign4 text=\\\\ linehl=Comment
173 sign undefine Sign4
174 sign define Sign4 text=\\ linehl=Comment
175 sign undefine Sign4
176
Bram Moolenaara3556522018-12-31 22:02:29 +0100177 " define a sign with a leading 0 in the name
178 sign unplace *
179 sign define 004 text=#> linehl=Comment
180 let a = execute('sign list 4')
181 call assert_equal("\nsign 4 text=#> linehl=Comment", a)
182 exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
183 let a = execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100184 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100185 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100186 exe 'sign unplace 20 buffer=' . bufnr('')
187 sign undefine 004
188 call assert_fails('sign list 4', 'E155:')
189
Bram Moolenaar09de1752016-08-08 22:26:48 +0200190 " After undefining the sign, we should no longer be able to place it.
191 sign undefine Sign1
192 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200193 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100194 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
195 \ bufnr('%'), 'E155:')
Luuk van Baale670d172023-11-19 10:55:35 +0100196
197 " Defining a sign without attributes is allowed.
198 sign define Sign1
199 call assert_equal([{'name': 'Sign1'}], sign_getdefined())
200 sign undefine Sign1
Bram Moolenaar446a9732016-08-10 21:36:23 +0200201endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200202
Bram Moolenaar2b1ddf12022-09-21 11:21:57 +0100203func Test_sign_many_bytes()
204 new
205 set signcolumn=number
206 set number
207 call setline(1, 'some text')
208 " composing characters can use many bytes, check for overflow
209 sign define manyBytes text=▶᷄᷅᷆◀᷄᷅᷆᷇
210 sign place 17 line=1 name=manyBytes
211 redraw
212
213 bwipe!
214 sign undefine manyBytes
215endfunc
216
Bram Moolenaar446a9732016-08-10 21:36:23 +0200217" Undefining placed sign is not recommended.
218" Quoting :help sign
219"
220" :sign undefine {name}
221" Deletes a previously defined sign. If signs with this {name}
222" are still placed this will cause trouble.
223func Test_sign_undefine_still_placed()
224 new foobar
225 sign define Sign text=x
226 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
227 sign undefine Sign
228
229 " Listing placed sign should show that sign is deleted.
230 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100231 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100232 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200233
234 sign unplace 41
235 let a=execute('sign place')
236 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200237endfunc
238
239func Test_sign_completion()
240 sign define Sign1 text=x
241 sign define Sign2 text=y
242
243 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
244 call assert_equal('"sign define jump list place undefine unplace', @:)
245
246 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
LemonBoyb975ddf2024-07-06 18:04:09 +0200247 call assert_equal('"sign define Sign culhl= icon= linehl= numhl= priority= text= texthl=', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200248
James McCoya80aad72021-12-22 19:45:28 +0000249 for hl in ['culhl', 'linehl', 'numhl', 'texthl']
250 call feedkeys(":sign define Sign "..hl.."=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
251 call assert_equal('"sign define Sign '..hl..'=SpellBad SpellCap ' .
252 \ 'SpellLocal SpellRare', @:)
253 endfor
Bram Moolenaar3678f652019-02-17 14:50:25 +0100254
Bram Moolenaar56564962022-10-10 22:39:42 +0100255 call writefile(repeat(["Sun is shining"], 30), "XsignOne", 'D')
256 call writefile(repeat(["Sky is blue"], 30), "XsignTwo", 'D')
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200257 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
258 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200259
Bram Moolenaar3678f652019-02-17 14:50:25 +0100260 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200261 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
262 call assert_equal('"sign undefine Sign1 Sign2', @:)
263
264 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100265 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
266 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200267
268 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
269 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
270
Bram Moolenaar3678f652019-02-17 14:50:25 +0100271 edit XsignOne
272 sign place 1 name=Sign1 line=5
273 sign place 1 name=Sign1 group=g1 line=10
274 edit XsignTwo
275 sign place 1 name=Sign2 group=g2 line=15
276
277 " Test for completion of group= and file= arguments to ':sign place'
278 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
279 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
280 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
281 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
282
283 " Test for completion of arguments to 'sign place' without sign identifier
284 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
285 call assert_equal('"sign place buffer= file= group=', @:)
286 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
287 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
288 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
289 call assert_equal('"sign place group=g1 g2', @:)
290 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
291 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
292
293 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200294 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100295 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100296 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
297 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
298 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
299 call assert_equal('"sign unplace 1 group=g1 g2', @:)
300 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
301 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200302
Bram Moolenaar3678f652019-02-17 14:50:25 +0100303 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200304 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
305 call assert_equal('"sign list Sign1 Sign2', @:)
306
Bram Moolenaar3678f652019-02-17 14:50:25 +0100307 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200308 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100309 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100310 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
311 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
312 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
313 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200314
Bram Moolenaar3678f652019-02-17 14:50:25 +0100315 " Error cases
316 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
317 call assert_equal('"sign here', @:)
318 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
319 call assert_equal("\"sign define Sign here=\<C-A>", @:)
320 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
321 call assert_equal("\"sign place 1 here=\<C-A>", @:)
322 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
323 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
324 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
325 call assert_equal("\"sign here there\<C-A>", @:)
326 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
327 call assert_equal("\"sign here there=\<C-A>", @:)
328
329 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200330 sign undefine Sign1
331 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100332 enew
Bram Moolenaar09de1752016-08-08 22:26:48 +0200333endfunc
334
335func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100336 sign define Sign1 text=x
337
Bram Moolenaar09de1752016-08-08 22:26:48 +0200338 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200339 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200340 call assert_fails('sign xxx', 'E160:')
341 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200342 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200343 call assert_fails('sign undefine', 'E156:')
344 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200345 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100346 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
347 call assert_fails('sign place buffer=999', 'E158:')
348 call assert_fails('sign jump buffer=999', 'E158:')
349 call assert_fails('sign jump 1 file=', 'E158:')
350 call assert_fails('sign jump 1 group=', 'E474:')
351 call assert_fails('sign jump 1 name=', 'E474:')
352 call assert_fails('sign jump 1 name=Sign1', 'E474:')
353 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200354 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100355 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100356 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
357 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100358 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100359 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
360 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100361 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100362 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
363 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100364 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100365 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
366 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100367 " Sign identifier and '*' for :sign unplace
368 call assert_fails("sign unplace 2 *", 'E474:')
369 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100370 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
371 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100372 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100373 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
374 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100375 call assert_fails("sign unplace 1 xxx", 'E474:')
376 call assert_fails("sign unplace * xxx", 'E474:')
377 call assert_fails("sign unplace xxx", 'E474:')
378 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100379 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100380 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100381 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100382 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100383 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100384 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100385 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100386 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100387 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100388 " Placing a sign with only sign identifier
389 call assert_fails("sign place 2", 'E474:')
390 " Placing a sign with only a name
391 call assert_fails("sign place abc", 'E474:')
392 " Placing a sign with only line number
393 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100394 " Placing a sign with only sign group
395 call assert_fails("sign place 5 group=g1", 'E474:')
396 call assert_fails("sign place 5 group=*", 'E474:')
397 " Placing a sign with only sign priority
398 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100399
400 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200401endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200402
403func Test_sign_delete_buffer()
404 new
405 sign define Sign text=x
406 let bufnr = bufnr('%')
407 new
408 exe 'bd ' . bufnr
409 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
410 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
411 sign unplace 61
412 sign undefine Sign
413endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100414
Bram Moolenaard933c822019-08-21 13:45:16 +0200415" Ignore error: E255: Couldn't read in sign data!
416" This error can happen when running in the GUI.
417" Some gui like Motif do not support the png icon format.
418func Sign_command_ignore_error(cmd)
419 try
420 exe a:cmd
421 catch /E255:/
422 endtry
423endfunc
424
425" ignore error: E255: Couldn't read in sign data!
426" This error can happen when running in gui.
427func Sign_define_ignore_error(name, attr)
428 try
429 call sign_define(a:name, a:attr)
430 catch /E255:/
431 endtry
432endfunc
433
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100434" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100435func Test_sign_funcs()
436 " Remove all the signs
437 call sign_unplace('*')
438 call sign_undefine()
439
440 " Tests for sign_define()
Bram Moolenaare413ea02021-11-24 16:20:13 +0000441 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error',
James McCoya80aad72021-12-22 19:45:28 +0000442 \ 'culhl': 'Visual', 'numhl': 'Number'}
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200443 call assert_equal(0, "sign1"->sign_define(attr))
James McCoya80aad72021-12-22 19:45:28 +0000444 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error', 'linehl' : 'Search',
445 \ 'culhl' : 'Visual', 'numhl': 'Number', 'text' : '=>'}],
Bram Moolenaare413ea02021-11-24 16:20:13 +0000446 \ sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100447
448 " Define a new sign without attributes and then update it
449 call sign_define("sign2")
450 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
James McCoya80aad72021-12-22 19:45:28 +0000451 \ 'culhl': 'DiffDelete', 'numhl': 'Number', 'icon' : 'sign2.ico'}
Bram Moolenaard933c822019-08-21 13:45:16 +0200452 call Sign_define_ignore_error("sign2", attr)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100453 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000454 \ 'linehl' : 'DiffAdd', 'culhl' : 'DiffDelete', 'text' : '!!',
James McCoya80aad72021-12-22 19:45:28 +0000455 \ 'numhl': 'Number', 'icon' : 'sign2.ico'}],
456 \ "sign2"->sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100457
458 " Test for a sign name with digits
459 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
460 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
461 \ sign_getdefined(0002))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200462 eval 0002->sign_undefine()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100463
464 " Tests for invalid arguments to sign_define()
465 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
466 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200467 call assert_fails('call sign_define({})', 'E731:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100468 call assert_fails('call sign_define("sign6", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100469
470 " Tests for sign_getdefined()
471 call assert_equal([], sign_getdefined("none"))
472 call assert_fails('call sign_getdefined({})', 'E731:')
473
474 " Tests for sign_place()
Bram Moolenaar56564962022-10-10 22:39:42 +0100475 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100476 edit Xsign
477
478 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
479 \ {'lnum' : 20}))
480 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
481 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
482 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
483 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
484 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
485 \ 'priority' : 10}]}],
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200486 \ '%'->sign_getplaced({'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100487 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
488 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
489 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100490 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100491
492 " Tests for invalid arguments to sign_place()
493 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
494 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100495 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100496 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
497 \ {"lnum" : 30})', 'E474:')
498 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
499 \ {"lnum" : 30})', 'E155:')
500 call assert_fails('call sign_place(10, "", "", "Xsign",
501 \ {"lnum" : 30})', 'E155:')
502 call assert_fails('call sign_place(10, "", [], "Xsign",
503 \ {"lnum" : 30})', 'E730:')
504 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
505 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100506 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100507 \ 'E158:')
508 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200509 \ 'E730:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100510 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200511 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100512 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200513 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100514 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200515 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100516 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
517
518 " Tests for sign_getplaced()
519 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
520 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
521 \ 'priority' : 10}]}],
522 \ sign_getplaced(bufnr('Xsign')))
523 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
524 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
525 \ 'priority' : 10}]}],
526 \ sign_getplaced())
527 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100528 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100529 call assert_fails('call sign_getplaced(-1)', 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100530 call assert_fails('call sign_getplaced("Xsign", [])', 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100531 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
532 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
533 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
534 \ 'E745:')
535 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
536 \ sign_getplaced('Xsign', {'id' : 44}))
537 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
538 \ 'E745:')
539
540 " Tests for sign_unplace()
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200541 eval 20->sign_place('', 'sign2', 'Xsign', {"lnum" : 30})
Bram Moolenaar162b7142018-12-21 15:17:36 +0100542 call assert_equal(0, sign_unplace('',
543 \ {'id' : 20, 'buffer' : 'Xsign'}))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200544 call assert_equal(-1, ''->sign_unplace(
Bram Moolenaar162b7142018-12-21 15:17:36 +0100545 \ {'id' : 30, 'buffer' : 'Xsign'}))
546 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
547 call assert_fails("call sign_unplace('',
548 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
549 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100550 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100551 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100552 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100553 call assert_fails("call sign_unplace('g1', 'mySign')", 'E1206:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100554
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200555 call sign_unplace('*')
556
557 " Test for modifying a placed sign
558 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
559 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
560 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
561 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
562 \ 'priority' : 10}]}],
563 \ sign_getplaced())
564
Bram Moolenaar162b7142018-12-21 15:17:36 +0100565 " Tests for sign_undefine()
566 call assert_equal(0, sign_undefine("sign1"))
567 call assert_equal([], sign_getdefined("sign1"))
568 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200569 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100570
Bram Moolenaar42aff462019-08-21 13:20:29 +0200571 " Test for using '.' as the line number for sign_place()
Bram Moolenaard933c822019-08-21 13:45:16 +0200572 call Sign_define_ignore_error("sign1", attr)
Bram Moolenaar42aff462019-08-21 13:20:29 +0200573 call cursor(22, 1)
574 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
575 \ {'lnum' : '.'}))
576 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
577 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
578 \ 'priority' : 10}]}],
579 \ sign_getplaced('%', {'lnum' : 22}))
580
Bram Moolenaar162b7142018-12-21 15:17:36 +0100581 call sign_unplace('*')
582 call sign_undefine()
583 enew | only
584endfunc
585
586" Tests for sign groups
587func Test_sign_group()
588 enew | only
589 " Remove all the signs
590 call sign_unplace('*')
591 call sign_undefine()
592
Bram Moolenaar56564962022-10-10 22:39:42 +0100593 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100594
595 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
596 call assert_equal(0, sign_define("sign1", attr))
597
598 edit Xsign
599 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100600
601 " Error case
602 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
603 \ {'lnum' : 30})", 'E730:')
604
605 " place three signs with the same identifier. One in the global group and
606 " others in the named groups
607 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
608 \ {'lnum' : 10}))
609 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
610 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
611
612 " Test for sign_getplaced() with group
613 let s = sign_getplaced('Xsign')
614 call assert_equal(1, len(s[0].signs))
615 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100616 let s = sign_getplaced(bnum, {'group' : ''})
617 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
618 \ 'priority' : 10}], s[0].signs)
619 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100620 let s = sign_getplaced(bnum, {'group' : 'g2'})
621 call assert_equal('g2', s[0].signs[0].group)
622 let s = sign_getplaced(bnum, {'group' : 'g3'})
623 call assert_equal([], s[0].signs)
624 let s = sign_getplaced(bnum, {'group' : '*'})
625 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
626 \ 'priority' : 10},
627 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
628 \ 'priority' : 10},
629 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
630 \ 'priority' : 10}],
631 \ s[0].signs)
632
633 " Test for sign_getplaced() with id
634 let s = sign_getplaced(bnum, {'id' : 5})
635 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
636 \ 'priority' : 10}],
637 \ s[0].signs)
638 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
639 call assert_equal(
640 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
641 \ 'priority' : 10}],
642 \ s[0].signs)
643 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
644 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
645 \ 'priority' : 10},
646 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
647 \ 'priority' : 10},
648 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
649 \ 'priority' : 10}],
650 \ s[0].signs)
651 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
652 call assert_equal([], s[0].signs)
653
654 " Test for sign_getplaced() with lnum
655 let s = sign_getplaced(bnum, {'lnum' : 20})
656 call assert_equal([], s[0].signs)
657 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
658 call assert_equal(
659 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
660 \ 'priority' : 10}],
661 \ s[0].signs)
662 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
663 call assert_equal(
664 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
665 \ 'priority' : 10}],
666 \ s[0].signs)
667 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
668 call assert_equal([], s[0].signs)
669
670 " Error case
671 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
672 \ 'E730:')
673
674 " Clear the sign in global group
675 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
676 let s = sign_getplaced(bnum, {'group' : '*'})
677 call assert_equal([
678 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
679 \ 'priority' : 10},
680 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
681 \ 'priority' : 10}],
682 \ s[0].signs)
683
684 " Clear the sign in one of the groups
685 call sign_unplace('g1', {'buffer' : 'Xsign'})
686 let s = sign_getplaced(bnum, {'group' : '*'})
687 call assert_equal([
688 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
689 \ 'priority' : 10}],
690 \ s[0].signs)
691
692 " Clear all the signs from the buffer
693 call sign_unplace('*', {'buffer' : bnum})
694 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
695
696 " Clear sign across groups using an identifier
697 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
698 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
699 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
700 call assert_equal(0, sign_unplace('*', {'id' : 25}))
701 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
702
703 " Error case
Yegappan Lakshmanan8deb2b32022-09-02 15:15:27 +0100704 call assert_fails("call sign_unplace({})", 'E1174:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100705
706 " Place a sign in the global group and try to delete it using a group
707 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
708 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
709
710 " Place signs in multiple groups and delete all the signs in one of the
711 " group
712 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
713 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
714 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
715 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
716 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
717 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
718 call assert_equal(0, sign_unplace('g1'))
719 let s = sign_getplaced(bnum, {'group' : 'g1'})
720 call assert_equal([], s[0].signs)
721 let s = sign_getplaced(bnum)
722 call assert_equal(2, len(s[0].signs))
723 let s = sign_getplaced(bnum, {'group' : 'g2'})
724 call assert_equal('g2', s[0].signs[0].group)
725 call assert_equal(0, sign_unplace('', {'id' : 5}))
726 call assert_equal(0, sign_unplace('', {'id' : 6}))
727 let s = sign_getplaced(bnum, {'group' : 'g2'})
728 call assert_equal('g2', s[0].signs[0].group)
729 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
730
731 call sign_unplace('*')
732
733 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100734 sign place 5 line=10 name=sign1 file=Xsign
735 sign place 5 group=g1 line=10 name=sign1 file=Xsign
736 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100737
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100738 " Tests for the ':sign place' command
739
740 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100741 let a = execute('sign place file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100742 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100743 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100744
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100745 " :sign place group={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100746 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100747 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100748 \ " line=10 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100749
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100750 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100751 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100752 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100753 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
754 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
755 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100756
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100757 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100758 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100759 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
760
761 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100762 let bnum = bufnr('Xsign')
763 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
764 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
765 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
766
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100767 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100768 let a = execute('sign place buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100769 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100770 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100771
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100772 " :sign place group={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100773 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100774 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100775 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100776
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100777 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100778 let a = execute('sign place group=* buffer=' . bnum)
779 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100780 \ " line=10 id=5 name=sign1 priority=10\n" .
781 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
782 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100783
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100784 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100785 let a = execute('sign place group=xyz buffer=' . bnum)
786 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
787
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100788 " :sign place
789 let a = execute('sign place')
790 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100791 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100792
Bram Moolenaarb589f952019-01-07 22:10:00 +0100793 " Place signs in more than one buffer and list the signs
794 split foo
795 set buftype=nofile
796 sign place 25 line=76 name=sign1 priority=99 file=foo
797 let a = execute('sign place')
798 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
799 \ " line=10 id=5 name=sign1 priority=10\n" .
800 \ "Signs for foo:\n" .
801 \ " line=76 id=25 name=sign1 priority=99\n", a)
802 close
803 bwipe foo
804
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100805 " :sign place group={group}
806 let a = execute('sign place group=g1')
807 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100808 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100809
810 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100811 let a = execute('sign place group=*')
812 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100813 \ " line=10 id=5 name=sign1 priority=10\n" .
814 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
815 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100816
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100817 " Test for ':sign jump' command with groups
818 sign jump 5 group=g1 file=Xsign
819 call assert_equal(11, line('.'))
820 call assert_equal('Xsign', bufname(''))
821 sign jump 5 group=g2 file=Xsign
822 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100823
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100824 " Test for :sign jump command without the filename or buffer
825 sign jump 5
826 call assert_equal(10, line('.'))
827 sign jump 5 group=g1
828 call assert_equal(11, line('.'))
829
Bram Moolenaar162b7142018-12-21 15:17:36 +0100830 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100831 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100832
Bram Moolenaar162b7142018-12-21 15:17:36 +0100833 call sign_unplace('*')
834 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100835 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100836endfunc
837
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100838" Place signs used for ":sign unplace" command test
839func Place_signs_for_test()
840 call sign_unplace('*')
841
842 sign place 3 line=10 name=sign1 file=Xsign1
843 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
844 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
845 sign place 4 line=15 name=sign1 file=Xsign1
846 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
847 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
848 sign place 5 line=20 name=sign1 file=Xsign2
849 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
850 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
851 sign place 6 line=25 name=sign1 file=Xsign2
852 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
853 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
854endfunc
855
856" Place multiple signs in a single line for test
857func Place_signs_at_line_for_test()
858 call sign_unplace('*')
859 sign place 3 line=13 name=sign1 file=Xsign1
860 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
861 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
862 sign place 4 line=13 name=sign1 file=Xsign1
863 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
864 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
865endfunc
866
867" Tests for the ':sign unplace' command
868func Test_sign_unplace()
869 enew | only
870 " Remove all the signs
871 call sign_unplace('*')
872 call sign_undefine()
873
874 " Create two files and define signs
Bram Moolenaar56564962022-10-10 22:39:42 +0100875 call writefile(repeat(["Sun is shining"], 30), "Xsign1", 'D')
876 call writefile(repeat(["It is beautiful"], 30), "Xsign2", 'D')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100877
878 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
879 call sign_define("sign1", attr)
880
881 edit Xsign1
882 let bnum1 = bufnr('%')
883 split Xsign2
884 let bnum2 = bufnr('%')
885
886 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
887 \ 'priority' : 10},
888 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
889 \ 'priority' : 10},
890 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
891 \ 'priority' : 10},
892 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
893 \ 'priority' : 10},
894 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
895 \ 'priority' : 10},
896 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
897 \ 'priority' : 10},]
898 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
899 \ 'priority' : 10},
900 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
901 \ 'priority' : 10},
902 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
903 \ 'priority' : 10},
904 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
905 \ 'priority' : 10},
906 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
907 \ 'priority' : 10},
908 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
909 \ 'priority' : 10},]
910
911 " Test for :sign unplace {id} file={fname}
912 call Place_signs_for_test()
913 sign unplace 3 file=Xsign1
914 sign unplace 6 file=Xsign2
915 call assert_equal(
916 \ filter(copy(signs1),
917 \ {idx, val -> val.id != 3 || val.group != ''}),
918 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
919 call assert_equal(
920 \ filter(copy(signs2),
921 \ {idx, val -> val.id != 6 || val.group != ''}),
922 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
923
924 " Test for :sign unplace {id} group={group} file={fname}
925 call Place_signs_for_test()
926 sign unplace 4 group=g1 file=Xsign1
927 sign unplace 5 group=g2 file=Xsign2
928 call assert_equal(
929 \ filter(copy(signs1),
930 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
931 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
932 call assert_equal(
933 \ filter(copy(signs2),
934 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
935 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
936
937 " Test for :sign unplace {id} group=* file={fname}
938 call Place_signs_for_test()
939 sign unplace 3 group=* file=Xsign1
940 sign unplace 6 group=* file=Xsign2
941 call assert_equal(
942 \ filter(copy(signs1),
943 \ {idx, val -> val.id != 3}),
944 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
945 call assert_equal(
946 \ filter(copy(signs2),
947 \ {idx, val -> val.id != 6}),
948 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
949
950 " Test for :sign unplace * file={fname}
951 call Place_signs_for_test()
952 sign unplace * file=Xsign1
953 call assert_equal(
954 \ filter(copy(signs1),
955 \ {idx, val -> val.group != ''}),
956 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
957 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
958
959 " Test for :sign unplace * group={group} file={fname}
960 call Place_signs_for_test()
961 sign unplace * group=g1 file=Xsign1
962 sign unplace * group=g2 file=Xsign2
963 call assert_equal(
964 \ filter(copy(signs1),
965 \ {idx, val -> val.group != 'g1'}),
966 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
967 call assert_equal(
968 \ filter(copy(signs2),
969 \ {idx, val -> val.group != 'g2'}),
970 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
971
972 " Test for :sign unplace * group=* file={fname}
973 call Place_signs_for_test()
974 sign unplace * group=* file=Xsign2
975 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
976 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
977
978 " Test for :sign unplace {id} buffer={nr}
979 call Place_signs_for_test()
980 exe 'sign unplace 3 buffer=' . bnum1
981 exe 'sign unplace 6 buffer=' . bnum2
982 call assert_equal(
983 \ filter(copy(signs1),
984 \ {idx, val -> val.id != 3 || val.group != ''}),
985 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
986 call assert_equal(
987 \ filter(copy(signs2),
988 \ {idx, val -> val.id != 6 || val.group != ''}),
989 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
990
991 " Test for :sign unplace {id} group={group} buffer={nr}
992 call Place_signs_for_test()
993 exe 'sign unplace 4 group=g1 buffer=' . bnum1
994 exe 'sign unplace 5 group=g2 buffer=' . bnum2
995 call assert_equal(
996 \ filter(copy(signs1),
997 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
998 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
999 call assert_equal(
1000 \ filter(copy(signs2),
1001 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
1002 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1003
1004 " Test for :sign unplace {id} group=* buffer={nr}
1005 call Place_signs_for_test()
1006 exe 'sign unplace 3 group=* buffer=' . bnum1
1007 exe 'sign unplace 6 group=* buffer=' . bnum2
1008 call assert_equal(
1009 \ filter(copy(signs1),
1010 \ {idx, val -> val.id != 3}),
1011 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1012 call assert_equal(
1013 \ filter(copy(signs2),
1014 \ {idx, val -> val.id != 6}),
1015 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1016
1017 " Test for :sign unplace * buffer={nr}
1018 call Place_signs_for_test()
1019 exe 'sign unplace * buffer=' . bnum1
1020 call assert_equal(
1021 \ filter(copy(signs1),
1022 \ {idx, val -> val.group != ''}),
1023 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1024 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1025
1026 " Test for :sign unplace * group={group} buffer={nr}
1027 call Place_signs_for_test()
1028 exe 'sign unplace * group=g1 buffer=' . bnum1
1029 exe 'sign unplace * group=g2 buffer=' . bnum2
1030 call assert_equal(
1031 \ filter(copy(signs1),
1032 \ {idx, val -> val.group != 'g1'}),
1033 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1034 call assert_equal(
1035 \ filter(copy(signs2),
1036 \ {idx, val -> val.group != 'g2'}),
1037 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1038
1039 " Test for :sign unplace * group=* buffer={nr}
1040 call Place_signs_for_test()
1041 exe 'sign unplace * group=* buffer=' . bnum2
1042 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1043 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1044
1045 " Test for :sign unplace {id}
1046 call Place_signs_for_test()
1047 sign unplace 4
1048 sign unplace 6
1049 call assert_equal(
1050 \ filter(copy(signs1),
1051 \ {idx, val -> val.id != 4 || val.group != ''}),
1052 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1053 call assert_equal(
1054 \ filter(copy(signs2),
1055 \ {idx, val -> val.id != 6 || val.group != ''}),
1056 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1057
1058 " Test for :sign unplace {id} group={group}
1059 call Place_signs_for_test()
1060 sign unplace 4 group=g1
1061 sign unplace 6 group=g2
1062 call assert_equal(
1063 \ filter(copy(signs1),
1064 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1065 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1066 call assert_equal(
1067 \ filter(copy(signs2),
1068 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1069 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1070
1071 " Test for :sign unplace {id} group=*
1072 call Place_signs_for_test()
1073 sign unplace 3 group=*
1074 sign unplace 5 group=*
1075 call assert_equal(
1076 \ filter(copy(signs1),
1077 \ {idx, val -> val.id != 3}),
1078 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1079 call assert_equal(
1080 \ filter(copy(signs2),
1081 \ {idx, val -> val.id != 5}),
1082 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1083
1084 " Test for :sign unplace *
1085 call Place_signs_for_test()
1086 sign unplace *
1087 call assert_equal(
1088 \ filter(copy(signs1),
1089 \ {idx, val -> val.group != ''}),
1090 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1091 call assert_equal(
1092 \ filter(copy(signs2),
1093 \ {idx, val -> val.group != ''}),
1094 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1095
1096 " Test for :sign unplace * group={group}
1097 call Place_signs_for_test()
1098 sign unplace * group=g1
1099 call assert_equal(
1100 \ filter(copy(signs1),
1101 \ {idx, val -> val.group != 'g1'}),
1102 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1103 call assert_equal(
1104 \ filter(copy(signs2),
1105 \ {idx, val -> val.group != 'g1'}),
1106 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1107
1108 " Test for :sign unplace * group=*
1109 call Place_signs_for_test()
1110 sign unplace * group=*
1111 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1112 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1113
1114 " Negative test cases
1115 call Place_signs_for_test()
1116 sign unplace 3 group=xy file=Xsign1
1117 sign unplace * group=xy file=Xsign1
1118 silent! sign unplace * group=* file=FileNotPresent
1119 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1120 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1121
1122 " Tests for removing sign at the current cursor position
1123
1124 " Test for ':sign unplace'
1125 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1126 \ 'priority' : 10},
1127 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1128 \ 'priority' : 10},
1129 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1130 \ 'priority' : 10},
1131 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1132 \ 'priority' : 10},
1133 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1134 \ 'priority' : 10},
1135 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1136 \ 'priority' : 10},]
1137 exe bufwinnr('Xsign1') . 'wincmd w'
1138 call cursor(13, 1)
1139
1140 " Should remove only one sign in the global group
1141 call Place_signs_at_line_for_test()
1142 sign unplace
1143 call assert_equal(
1144 \ filter(copy(signs1),
1145 \ {idx, val -> val.id != 4 || val.group != ''}),
1146 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1147 " Should remove the second sign in the global group
1148 sign unplace
1149 call assert_equal(
1150 \ filter(copy(signs1),
1151 \ {idx, val -> val.group != ''}),
1152 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1153
1154 " Test for ':sign unplace group={group}'
1155 call Place_signs_at_line_for_test()
1156 " Should remove only one sign in group g1
1157 sign unplace group=g1
1158 call assert_equal(
1159 \ filter(copy(signs1),
1160 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1161 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1162 sign unplace group=g2
1163 call assert_equal(
1164 \ filter(copy(signs1),
1165 \ {idx, val -> val.id != 4 || val.group == ''}),
1166 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1167
1168 " Test for ':sign unplace group=*'
1169 call Place_signs_at_line_for_test()
1170 sign unplace group=*
1171 sign unplace group=*
1172 sign unplace group=*
1173 call assert_equal(
1174 \ filter(copy(signs1),
1175 \ {idx, val -> val.id != 4}),
1176 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1177 sign unplace group=*
1178 sign unplace group=*
1179 sign unplace group=*
1180 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1181
1182 call sign_unplace('*')
1183 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001184 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001185endfunc
1186
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001187" Tests for auto-generating the sign identifier.
1188func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001189 enew | only
1190 call sign_unplace('*')
1191 call sign_undefine()
1192
1193 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1194 call assert_equal(0, sign_define("sign1", attr))
1195
Bram Moolenaar56564962022-10-10 22:39:42 +01001196 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001197 edit Xsign
1198
1199 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1200 \ {'lnum' : 10}))
1201 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1202 \ {'lnum' : 12}))
1203 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1204 \ {'lnum' : 14}))
1205 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001206 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001207 \ {'lnum' : 12}))
1208
1209 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1210 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001211 " Check for the next generated sign id in this group
1212 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1213 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001214 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1215 call assert_equal(10,
1216 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1217
Bram Moolenaar162b7142018-12-21 15:17:36 +01001218 call sign_unplace('*')
1219 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001220 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001221endfunc
1222
1223" Test for sign priority
1224func Test_sign_priority()
1225 enew | only
1226 call sign_unplace('*')
1227 call sign_undefine()
1228
1229 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1230 call sign_define("sign1", attr)
1231 call sign_define("sign2", attr)
1232 call sign_define("sign3", attr)
LemonBoyb975ddf2024-07-06 18:04:09 +02001233 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search', 'priority': 60}
1234 call sign_define("sign4", attr)
1235
1236 " Test for :sign list
1237 let a = execute('sign list')
1238 call assert_equal("\nsign sign1 text==> linehl=Search texthl=Search\n" .
1239 \ "sign sign2 text==> linehl=Search texthl=Search\n" .
1240 \ "sign sign3 text==> linehl=Search texthl=Search\n" .
1241 \ "sign sign4 text==> priority=60 linehl=Search texthl=Search", a)
1242
1243 " Test for sign_getdefined()
1244 let s = sign_getdefined()
1245 call assert_equal([
1246 \ {'name': 'sign1', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1247 \ {'name': 'sign2', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1248 \ {'name': 'sign3', 'texthl': 'Search', 'linehl': 'Search', 'text': '=>'},
1249 \ {'name': 'sign4', 'priority': 60, 'texthl': 'Search', 'linehl': 'Search',
1250 \ 'text': '=>'}],
1251 \ s)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001252
1253 " Place three signs with different priority in the same line
Bram Moolenaar56564962022-10-10 22:39:42 +01001254 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001255 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001256
1257 call sign_place(1, 'g1', 'sign1', 'Xsign',
1258 \ {'lnum' : 11, 'priority' : 50})
1259 call sign_place(2, 'g2', 'sign2', 'Xsign',
1260 \ {'lnum' : 11, 'priority' : 100})
1261 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1262 let s = sign_getplaced('Xsign', {'group' : '*'})
1263 call assert_equal([
1264 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1265 \ 'priority' : 100},
1266 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1267 \ 'priority' : 50},
1268 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1269 \ 'priority' : 10}],
1270 \ s[0].signs)
1271
Bram Moolenaar64416122019-06-07 21:37:13 +02001272 call sign_unplace('*')
1273
1274 " Three signs on different lines with changing priorities
1275 call sign_place(1, '', 'sign1', 'Xsign',
1276 \ {'lnum' : 11, 'priority' : 50})
1277 call sign_place(2, '', 'sign2', 'Xsign',
1278 \ {'lnum' : 12, 'priority' : 60})
1279 call sign_place(3, '', 'sign3', 'Xsign',
1280 \ {'lnum' : 13, 'priority' : 70})
1281 call sign_place(2, '', 'sign2', 'Xsign',
1282 \ {'lnum' : 12, 'priority' : 40})
1283 call sign_place(3, '', 'sign3', 'Xsign',
1284 \ {'lnum' : 13, 'priority' : 30})
1285 call sign_place(1, '', 'sign1', 'Xsign',
1286 \ {'lnum' : 11, 'priority' : 50})
1287 let s = sign_getplaced('Xsign', {'group' : '*'})
1288 call assert_equal([
1289 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1290 \ 'priority' : 50},
1291 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1292 \ 'priority' : 40},
1293 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1294 \ 'priority' : 30}],
1295 \ s[0].signs)
1296
1297 call sign_unplace('*')
1298
1299 " Two signs on the same line with changing priorities
1300 call sign_place(1, '', 'sign1', 'Xsign',
1301 \ {'lnum' : 4, 'priority' : 20})
1302 call sign_place(2, '', 'sign2', 'Xsign',
1303 \ {'lnum' : 4, 'priority' : 30})
1304 let s = sign_getplaced('Xsign', {'group' : '*'})
1305 call assert_equal([
1306 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1307 \ 'priority' : 30},
1308 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1309 \ 'priority' : 20}],
1310 \ s[0].signs)
1311 " Change the priority of the last sign to highest
1312 call sign_place(1, '', 'sign1', 'Xsign',
1313 \ {'lnum' : 4, 'priority' : 40})
1314 let s = sign_getplaced('Xsign', {'group' : '*'})
1315 call assert_equal([
1316 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1317 \ 'priority' : 40},
1318 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1319 \ 'priority' : 30}],
1320 \ s[0].signs)
1321 " Change the priority of the first sign to lowest
1322 call sign_place(1, '', 'sign1', 'Xsign',
1323 \ {'lnum' : 4, 'priority' : 25})
1324 let s = sign_getplaced('Xsign', {'group' : '*'})
1325 call assert_equal([
1326 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1327 \ 'priority' : 30},
1328 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1329 \ 'priority' : 25}],
1330 \ s[0].signs)
1331 call sign_place(1, '', 'sign1', 'Xsign',
1332 \ {'lnum' : 4, 'priority' : 45})
1333 call sign_place(2, '', 'sign2', 'Xsign',
1334 \ {'lnum' : 4, 'priority' : 55})
1335 let s = sign_getplaced('Xsign', {'group' : '*'})
1336 call assert_equal([
1337 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1338 \ 'priority' : 55},
1339 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1340 \ 'priority' : 45}],
1341 \ s[0].signs)
1342
1343 call sign_unplace('*')
1344
1345 " Three signs on the same line with changing priorities
1346 call sign_place(1, '', 'sign1', 'Xsign',
1347 \ {'lnum' : 4, 'priority' : 40})
1348 call sign_place(2, '', 'sign2', 'Xsign',
1349 \ {'lnum' : 4, 'priority' : 30})
1350 call sign_place(3, '', 'sign3', 'Xsign',
1351 \ {'lnum' : 4, 'priority' : 20})
1352 let s = sign_getplaced('Xsign', {'group' : '*'})
1353 call assert_equal([
1354 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1355 \ 'priority' : 40},
1356 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1357 \ 'priority' : 30},
1358 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1359 \ 'priority' : 20}],
1360 \ s[0].signs)
1361
1362 " Change the priority of the middle sign to the highest
1363 call sign_place(2, '', 'sign2', 'Xsign',
1364 \ {'lnum' : 4, 'priority' : 50})
1365 let s = sign_getplaced('Xsign', {'group' : '*'})
1366 call assert_equal([
1367 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1368 \ 'priority' : 50},
1369 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1370 \ 'priority' : 40},
1371 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1372 \ 'priority' : 20}],
1373 \ s[0].signs)
1374
1375 " Change the priority of the middle sign to the lowest
1376 call sign_place(1, '', 'sign1', 'Xsign',
1377 \ {'lnum' : 4, 'priority' : 15})
1378 let s = sign_getplaced('Xsign', {'group' : '*'})
1379 call assert_equal([
1380 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1381 \ 'priority' : 50},
1382 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1383 \ 'priority' : 20},
1384 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1385 \ 'priority' : 15}],
1386 \ s[0].signs)
1387
1388 " Change the priority of the last sign to the highest
1389 call sign_place(1, '', 'sign1', 'Xsign',
1390 \ {'lnum' : 4, 'priority' : 55})
1391 let s = sign_getplaced('Xsign', {'group' : '*'})
1392 call assert_equal([
1393 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1394 \ 'priority' : 55},
1395 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1396 \ 'priority' : 50},
1397 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1398 \ 'priority' : 20}],
1399 \ s[0].signs)
1400
1401 " Change the priority of the first sign to the lowest
1402 call sign_place(1, '', 'sign1', 'Xsign',
1403 \ {'lnum' : 4, 'priority' : 15})
1404 let s = sign_getplaced('Xsign', {'group' : '*'})
1405 call assert_equal([
1406 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1407 \ 'priority' : 50},
1408 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1409 \ 'priority' : 20},
1410 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1411 \ 'priority' : 15}],
1412 \ s[0].signs)
1413
1414 call sign_unplace('*')
1415
1416 " Three signs on the same line with changing priorities along with other
1417 " signs
1418 call sign_place(1, '', 'sign1', 'Xsign',
1419 \ {'lnum' : 2, 'priority' : 10})
1420 call sign_place(2, '', 'sign1', 'Xsign',
1421 \ {'lnum' : 4, 'priority' : 30})
1422 call sign_place(3, '', 'sign2', 'Xsign',
1423 \ {'lnum' : 4, 'priority' : 20})
1424 call sign_place(4, '', 'sign3', 'Xsign',
1425 \ {'lnum' : 4, 'priority' : 25})
1426 call sign_place(5, '', 'sign2', 'Xsign',
1427 \ {'lnum' : 6, 'priority' : 80})
1428 let s = sign_getplaced('Xsign', {'group' : '*'})
1429 call assert_equal([
1430 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1431 \ 'priority' : 10},
1432 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1433 \ 'priority' : 30},
1434 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1435 \ 'priority' : 25},
1436 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1437 \ 'priority' : 20},
1438 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1439 \ 'priority' : 80}],
1440 \ s[0].signs)
1441
1442 " Change the priority of the first sign to lowest
1443 call sign_place(2, '', 'sign1', 'Xsign',
1444 \ {'lnum' : 4, 'priority' : 15})
1445 let s = sign_getplaced('Xsign', {'group' : '*'})
1446 call assert_equal([
1447 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1448 \ 'priority' : 10},
1449 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1450 \ 'priority' : 25},
1451 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1452 \ 'priority' : 20},
1453 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1454 \ 'priority' : 15},
1455 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1456 \ 'priority' : 80}],
1457 \ s[0].signs)
1458
1459 " Change the priority of the last sign to highest
1460 call sign_place(2, '', 'sign1', 'Xsign',
1461 \ {'lnum' : 4, 'priority' : 30})
1462 let s = sign_getplaced('Xsign', {'group' : '*'})
1463 call assert_equal([
1464 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1465 \ 'priority' : 10},
1466 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1467 \ 'priority' : 30},
1468 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1469 \ 'priority' : 25},
1470 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1471 \ 'priority' : 20},
1472 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1473 \ 'priority' : 80}],
1474 \ s[0].signs)
1475
1476 " Change the priority of the middle sign to lowest
1477 call sign_place(4, '', 'sign3', 'Xsign',
1478 \ {'lnum' : 4, 'priority' : 15})
1479 let s = sign_getplaced('Xsign', {'group' : '*'})
1480 call assert_equal([
1481 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1482 \ 'priority' : 10},
1483 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1484 \ 'priority' : 30},
1485 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1486 \ 'priority' : 20},
1487 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1488 \ 'priority' : 15},
1489 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1490 \ 'priority' : 80}],
1491 \ s[0].signs)
1492
1493 " Change the priority of the middle sign to highest
1494 call sign_place(3, '', 'sign2', 'Xsign',
1495 \ {'lnum' : 4, 'priority' : 35})
1496 let s = sign_getplaced('Xsign', {'group' : '*'})
1497 call assert_equal([
1498 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1499 \ 'priority' : 10},
1500 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1501 \ 'priority' : 35},
1502 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1503 \ 'priority' : 30},
1504 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1505 \ 'priority' : 15},
1506 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1507 \ 'priority' : 80}],
1508 \ s[0].signs)
1509
1510 call sign_unplace('*')
1511
1512 " Multiple signs with the same priority on the same line
1513 call sign_place(1, '', 'sign1', 'Xsign',
1514 \ {'lnum' : 4, 'priority' : 20})
1515 call sign_place(2, '', 'sign2', 'Xsign',
1516 \ {'lnum' : 4, 'priority' : 20})
1517 call sign_place(3, '', 'sign3', 'Xsign',
1518 \ {'lnum' : 4, 'priority' : 20})
1519 let s = sign_getplaced('Xsign', {'group' : '*'})
1520 call assert_equal([
1521 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1522 \ 'priority' : 20},
1523 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1524 \ 'priority' : 20},
1525 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1526 \ 'priority' : 20}],
1527 \ s[0].signs)
1528 " Place the last sign again with the same priority
1529 call sign_place(1, '', 'sign1', 'Xsign',
1530 \ {'lnum' : 4, 'priority' : 20})
1531 let s = sign_getplaced('Xsign', {'group' : '*'})
1532 call assert_equal([
1533 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1534 \ 'priority' : 20},
1535 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1536 \ 'priority' : 20},
1537 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1538 \ 'priority' : 20}],
1539 \ s[0].signs)
1540 " Place the first sign again with the same priority
1541 call sign_place(1, '', 'sign1', 'Xsign',
1542 \ {'lnum' : 4, 'priority' : 20})
1543 let s = sign_getplaced('Xsign', {'group' : '*'})
1544 call assert_equal([
1545 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1546 \ 'priority' : 20},
1547 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1548 \ 'priority' : 20},
1549 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1550 \ 'priority' : 20}],
1551 \ s[0].signs)
1552 " Place the middle sign again with the same priority
1553 call sign_place(3, '', 'sign3', 'Xsign',
1554 \ {'lnum' : 4, 'priority' : 20})
1555 let s = sign_getplaced('Xsign', {'group' : '*'})
1556 call assert_equal([
1557 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1558 \ 'priority' : 20},
1559 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1560 \ 'priority' : 20},
1561 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1562 \ 'priority' : 20}],
1563 \ s[0].signs)
1564
1565 call sign_unplace('*')
1566
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001567 " Place multiple signs with same id on a line with different priority
1568 call sign_place(1, '', 'sign1', 'Xsign',
1569 \ {'lnum' : 5, 'priority' : 20})
1570 call sign_place(1, '', 'sign2', 'Xsign',
1571 \ {'lnum' : 5, 'priority' : 10})
1572 let s = sign_getplaced('Xsign', {'lnum' : 5})
1573 call assert_equal([
1574 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1575 \ 'priority' : 10}],
1576 \ s[0].signs)
1577 call sign_place(1, '', 'sign2', 'Xsign',
1578 \ {'lnum' : 5, 'priority' : 5})
1579 let s = sign_getplaced('Xsign', {'lnum' : 5})
1580 call assert_equal([
1581 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1582 \ 'priority' : 5}],
1583 \ s[0].signs)
1584
Bram Moolenaar162b7142018-12-21 15:17:36 +01001585 " Error case
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001586 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign', [])", 'E1206:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001587 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1588 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001589 call sign_unplace('*')
1590
1591 " Tests for the :sign place command with priority
1592 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1593 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1594 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1595 let a = execute('sign place group=*')
1596 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001597 \ " line=10 id=5 name=sign1 priority=30\n" .
1598 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1599 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001600
1601 " Test for :sign place group={group}
1602 let a = execute('sign place group=g1')
1603 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001604 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001605
1606 call sign_unplace('*')
LemonBoyb975ddf2024-07-06 18:04:09 +02001607
1608 " Test for sign with default priority.
1609 call sign_place(1, 'g1', 'sign4', 'Xsign', {'lnum' : 3})
1610 sign place 2 line=5 name=sign4 group=g1 file=Xsign
1611
1612 let s = sign_getplaced('Xsign', {'group' : '*'})
1613 call assert_equal([
1614 \ {'id' : 1, 'name' : 'sign4', 'lnum' : 3, 'group' : 'g1',
1615 \ 'priority' : 60},
1616 \ {'id' : 2, 'name' : 'sign4', 'lnum' : 5, 'group' : 'g1',
1617 \ 'priority' : 60}],
1618 \ s[0].signs)
1619
1620 let a = execute('sign place group=g1')
1621 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
1622 \ " line=3 id=1 group=g1 name=sign4 priority=60\n" .
1623 \ " line=5 id=2 group=g1 name=sign4 priority=60\n", a)
1624
1625 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001626 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001627 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001628endfunc
1629
1630" Tests for memory allocation failures in sign functions
1631func Test_sign_memfailures()
Bram Moolenaar56564962022-10-10 22:39:42 +01001632 call writefile(repeat(["Sun is shining"], 30), "Xsign", 'D')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001633 edit Xsign
1634
1635 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1636 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1637 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1638 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1639 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1640 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1641 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1642
1643 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1644 call sign_define("sign1", attr)
1645 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1646 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1647
1648 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1649 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1650 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1651 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1652 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1653
1654 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1655 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1656 \ 'E342:')
1657
1658 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1659 call assert_fails('call getbufinfo()', 'E342:')
1660 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1661 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1662 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1663 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1664 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1665
1666 call sign_unplace('*')
1667 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001668 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001669endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001670
1671" Test for auto-adjusting the line number of a placed sign.
1672func Test_sign_lnum_adjust()
1673 enew! | only!
1674
1675 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001676 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001677 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1678 let l = sign_getplaced(bufnr(''))
1679 call assert_equal(3, l[0].signs[0].lnum)
1680
1681 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001682 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001683 let l = sign_getplaced(bufnr(''))
1684 call assert_equal(6, l[0].signs[0].lnum)
1685
1686 " Delete some lines before the sign and check the sign line number
1687 call deletebufline('%', 1, 2)
1688 let l = sign_getplaced(bufnr(''))
1689 call assert_equal(4, l[0].signs[0].lnum)
1690
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001691 " Insert some lines after the sign and check the sign line number
1692 call append(5, ['DA', 'DB'])
1693 let l = sign_getplaced(bufnr(''))
1694 call assert_equal(4, l[0].signs[0].lnum)
1695
1696 " Delete some lines after the sign and check the sign line number
1697 call deletebufline('', 6, 7)
1698 let l = sign_getplaced(bufnr(''))
1699 call assert_equal(4, l[0].signs[0].lnum)
1700
1701 " Break the undo. Otherwise the undo operation below will undo all the
1702 " changes made by this function.
Christian Brabandt6efb1982023-08-10 05:44:25 +02001703 let &g:undolevels=&g:undolevels
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001704
1705 " Delete the line with the sign
1706 call deletebufline('', 4)
1707 let l = sign_getplaced(bufnr(''))
1708 call assert_equal(4, l[0].signs[0].lnum)
1709
1710 " Undo the delete operation
1711 undo
1712 let l = sign_getplaced(bufnr(''))
1713 call assert_equal(5, l[0].signs[0].lnum)
1714
1715 " Break the undo
Christian Brabandt6efb1982023-08-10 05:44:25 +02001716 let &g:undolevels=&g:undolevels
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001717
1718 " Delete few lines at the end of the buffer including the line with the sign
1719 " Sign line number should not change (as it is placed outside of the buffer)
1720 call deletebufline('', 3, 6)
1721 let l = sign_getplaced(bufnr(''))
1722 call assert_equal(5, l[0].signs[0].lnum)
1723
1724 " Undo the delete operation. Sign should be restored to the previous line
1725 undo
1726 let l = sign_getplaced(bufnr(''))
1727 call assert_equal(5, l[0].signs[0].lnum)
1728
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001729 sign unplace * group=*
1730 sign undefine sign1
1731 enew!
1732endfunc
1733
1734" Test for changing the type of a placed sign
1735func Test_sign_change_type()
1736 enew! | only!
1737
1738 sign define sign1 text=#> linehl=Comment
1739 sign define sign2 text=@@ linehl=Comment
1740
1741 call setline(1, ['A', 'B', 'C', 'D'])
1742 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1743 let l = sign_getplaced(bufnr(''))
1744 call assert_equal('sign1', l[0].signs[0].name)
1745 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1746 let l = sign_getplaced(bufnr(''))
1747 call assert_equal('sign2', l[0].signs[0].name)
1748 call sign_place(4, '', 'sign1', '')
1749 let l = sign_getplaced(bufnr(''))
1750 call assert_equal('sign1', l[0].signs[0].name)
1751
1752 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1753 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1754 call assert_equal('sign1', l[0].signs[0].name)
1755 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1756 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1757 call assert_equal('sign2', l[0].signs[0].name)
1758 call sign_place(4, 'g1', 'sign1', '')
1759 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1760 call assert_equal('sign1', l[0].signs[0].name)
1761
1762 sign unplace * group=*
1763 sign undefine sign1
1764 sign undefine sign2
1765 enew!
1766endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001767
1768" Test for the sign_jump() function
1769func Test_sign_jump_func()
1770 enew! | only!
1771
1772 sign define sign1 text=#> linehl=Comment
1773
1774 edit foo
1775 set buftype=nofile
1776 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1777 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1778 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1779 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1780 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1781 split bar
1782 set buftype=nofile
1783 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1784 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1785 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1786 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1787 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1788
1789 let r = sign_jump(5, '', 'foo')
1790 call assert_equal(2, r)
1791 call assert_equal(2, line('.'))
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001792 let r = 6->sign_jump('g1', 'foo')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001793 call assert_equal(5, r)
1794 call assert_equal(5, line('.'))
1795 let r = sign_jump(5, '', 'bar')
1796 call assert_equal(2, r)
1797 call assert_equal(2, line('.'))
1798
1799 " Error cases
1800 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1801 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1802 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1803 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1804 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001805 call assert_fails('call sign_jump(2, "", {})', 'E731:')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001806 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1807
1808 sign unplace * group=*
1809 sign undefine sign1
1810 enew! | only!
1811endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001812
1813" Test for correct cursor position after the sign column appears or disappears.
1814func Test_sign_cursor_position()
Drew Vogelea67ba72025-05-07 22:05:17 +02001815 CheckScreendump
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=ï¼¶
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(" ï¼¶ 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
glepnir1b186832025-05-10 14:59:08 +02002105func Test_sign_number_without_signtext()
2106 CheckScreendump
2107 CheckRunVimInTerminal
2108
2109 let lines =<< trim END
2110 set number signcolumn=number
2111 call setline(1, ['a', 'b', 'c'])
2112 sign define SignA text=>> texthl=Search numhl=Error
2113 sign define SignB numhl=Error
2114 sign place 1 line=1 name=SignA buffer=1
2115 sign place 2 line=2 name=SignB buffer=1
2116 END
2117 call writefile(lines, 'XtestSigncolumnNumber', 'D')
2118 let buf = RunVimInTerminal('-S XtestSigncolumnNumber', {'rows': 5})
2119 call VerifyScreenDump(buf, 'Test_sign_number_without_signtext', {})
2120
2121 call StopVimInTerminal(buf)
2122endfunc
2123
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002124" vim: shiftwidth=2 sts=2 expandtab