blob: 06b2571aa29b32574883f5992a4be9e6d891ec00 [file] [log] [blame]
Bram Moolenaar09de1752016-08-08 22:26:48 +02001" Test for signs
2
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02003source check.vim
4CheckFeature signs
Bram Moolenaar09de1752016-08-08 22:26:48 +02005
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02006source screendump.vim
7
Bram Moolenaar09de1752016-08-08 22:26:48 +02008func Test_sign()
9 new
10 call setline(1, ['a', 'b', 'c', 'd'])
11
Bram Moolenaar446a9732016-08-10 21:36:23 +020012 " Define some signs.
13 " We can specify icons even if not all versions of vim support icons as
14 " icon is ignored when not supported. "(not supported)" is shown after
15 " the icon name when listing signs.
Bram Moolenaar09de1752016-08-08 22:26:48 +020016 sign define Sign1 text=x
Bram Moolenaar446a9732016-08-10 21:36:23 +020017 try
Bram Moolenaarb328cca2019-01-06 16:24:01 +010018 sign define Sign2 text=xy texthl=Title linehl=Error
19 \ icon=../../pixmaps/stock_vim_find_help.png
Bram Moolenaar446a9732016-08-10 21:36:23 +020020 catch /E255:/
Bram Moolenaar162b7142018-12-21 15:17:36 +010021 " Ignore error: E255: Couldn't read in sign data!
22 " This error can happen when running in the GUI.
Bram Moolenaar446a9732016-08-10 21:36:23 +020023 " Some gui like Motif do not support the png icon format.
24 endtry
Bram Moolenaar09de1752016-08-08 22:26:48 +020025
26 " Test listing signs.
27 let a=execute('sign list')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010028 call assert_match('^\nsign Sign1 text=x \nsign Sign2 ' .
29 \ 'icon=../../pixmaps/stock_vim_find_help.png .*text=xy ' .
30 \ 'linehl=Error texthl=Title$', a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020031
32 let a=execute('sign list Sign1')
33 call assert_equal("\nsign Sign1 text=x ", a)
34
Bram Moolenaar7d83bf42018-12-29 18:53:55 +010035 " Split the window to the bottom to verify sign jump will stay in the
36 " current window if the buffer is displayed there.
Bram Moolenaar446a9732016-08-10 21:36:23 +020037 let bn = bufnr('%')
38 let wn = winnr()
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010039 exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
Bram Moolenaar09de1752016-08-08 22:26:48 +020040 1
Bram Moolenaar446a9732016-08-10 21:36:23 +020041 bot split
42 exe 'sign jump 41 buffer=' . bufnr('%')
43 call assert_equal('c', getline('.'))
44 call assert_equal(3, winnr())
45 call assert_equal(bn, bufnr('%'))
46 call assert_notequal(wn, winnr())
47
48 " Create a new buffer and check that ":sign jump" switches to the old buffer.
49 1
50 new foo
51 call assert_notequal(bn, bufnr('%'))
52 exe 'sign jump 41 buffer=' . bn
53 call assert_equal(bn, bufnr('%'))
Bram Moolenaar09de1752016-08-08 22:26:48 +020054 call assert_equal('c', getline('.'))
55
Bram Moolenaar446a9732016-08-10 21:36:23 +020056 " Redraw to make sure that screen redraw with sign gets exercised,
57 " with and without 'rightleft'.
58 if has('rightleft')
59 set rightleft
60 redraw
61 set norightleft
62 endif
63 redraw
Bram Moolenaar09de1752016-08-08 22:26:48 +020064
Bram Moolenaar446a9732016-08-10 21:36:23 +020065 " Check that we can't change sign.
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010066 call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
Bram Moolenaar446a9732016-08-10 21:36:23 +020067
68 " Check placed signs
Bram Moolenaar09de1752016-08-08 22:26:48 +020069 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010070 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010071 \ " line=3 id=41 name=Sign1 priority=10\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020072
Bram Moolenaar446a9732016-08-10 21:36:23 +020073 " Unplace the sign and try jumping to it again should fail.
74 sign unplace 41
Bram Moolenaar09de1752016-08-08 22:26:48 +020075 1
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010076 call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
Bram Moolenaar09de1752016-08-08 22:26:48 +020077 call assert_equal('a', getline('.'))
78
79 " Unplace sign on current line.
Bram Moolenaar446a9732016-08-10 21:36:23 +020080 exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020081 4
82 sign unplace
83 let a=execute('sign place')
84 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010085
Bram Moolenaar09de1752016-08-08 22:26:48 +020086 " Try again to unplace sign on current line, it should fail this time.
87 call assert_fails('sign unplace', 'E159:')
88
89 " Unplace all signs.
Bram Moolenaar446a9732016-08-10 21:36:23 +020090 exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020091 sign unplace *
92 let a=execute('sign place')
93 call assert_equal("\n--- Signs ---\n", a)
94
Bram Moolenaarb328cca2019-01-06 16:24:01 +010095 " Place a sign without specifying the filename or buffer
96 sign place 77 line=9 name=Sign2
97 let a=execute('sign place')
98 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010099 \ " line=9 id=77 name=Sign2 priority=10\n", a)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100100 sign unplace *
101
Bram Moolenaar446a9732016-08-10 21:36:23 +0200102 " Check :jump with file=...
103 edit foo
104 call setline(1, ['A', 'B', 'C', 'D'])
105
106 try
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100107 sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist
108 \ icon=doesnotexist.xpm
Bram Moolenaar446a9732016-08-10 21:36:23 +0200109 catch /E255:/
110 " ignore error: E255: it can happens for guis.
111 endtry
112
113 let fn = expand('%:p')
114 exe 'sign place 43 line=2 name=Sign3 file=' . fn
115 edit bar
116 call assert_notequal(fn, expand('%:p'))
117 exe 'sign jump 43 file=' . fn
118 call assert_equal('B', getline('.'))
119
Bram Moolenaara3556522018-12-31 22:02:29 +0100120 " Check for jumping to a sign in a hidden buffer
121 enew! | only!
122 edit foo
123 call setline(1, ['A', 'B', 'C', 'D'])
124 let fn = expand('%:p')
125 exe 'sign place 21 line=3 name=Sign3 file=' . fn
126 hide edit bar
127 exe 'sign jump 21 file=' . fn
128 call assert_equal('C', getline('.'))
129
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100130 " can't define a sign with a non-printable character as text
131 call assert_fails("sign define Sign4 text=\e linehl=Comment", 'E239:')
132 call assert_fails("sign define Sign4 text=a\e linehl=Comment", 'E239:')
133 call assert_fails("sign define Sign4 text=\ea linehl=Comment", 'E239:')
134
135 " Only 1 or 2 character text is allowed
136 call assert_fails("sign define Sign4 text=abc linehl=Comment", 'E239:')
137 call assert_fails("sign define Sign4 text= linehl=Comment", 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100138 call assert_fails("sign define Sign4 text=\\ ab linehl=Comment", 'E239:')
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100139
140 " define sign with whitespace
141 sign define Sign4 text=\ X linehl=Comment
142 sign undefine Sign4
143 sign define Sign4 linehl=Comment text=\ X
144 sign undefine Sign4
145
146 sign define Sign5 text=X\ linehl=Comment
147 sign undefine Sign5
148 sign define Sign5 linehl=Comment text=X\
149 sign undefine Sign5
150
151 " define sign with backslash
152 sign define Sign4 text=\\\\ linehl=Comment
153 sign undefine Sign4
154 sign define Sign4 text=\\ linehl=Comment
155 sign undefine Sign4
156
Bram Moolenaara3556522018-12-31 22:02:29 +0100157 " define a sign with a leading 0 in the name
158 sign unplace *
159 sign define 004 text=#> linehl=Comment
160 let a = execute('sign list 4')
161 call assert_equal("\nsign 4 text=#> linehl=Comment", a)
162 exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
163 let a = execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100164 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100165 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100166 exe 'sign unplace 20 buffer=' . bufnr('')
167 sign undefine 004
168 call assert_fails('sign list 4', 'E155:')
169
Bram Moolenaar09de1752016-08-08 22:26:48 +0200170 " After undefining the sign, we should no longer be able to place it.
171 sign undefine Sign1
172 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200173 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100174 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
175 \ bufnr('%'), 'E155:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200176endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200177
Bram Moolenaar446a9732016-08-10 21:36:23 +0200178" Undefining placed sign is not recommended.
179" Quoting :help sign
180"
181" :sign undefine {name}
182" Deletes a previously defined sign. If signs with this {name}
183" are still placed this will cause trouble.
184func Test_sign_undefine_still_placed()
185 new foobar
186 sign define Sign text=x
187 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
188 sign undefine Sign
189
190 " Listing placed sign should show that sign is deleted.
191 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100192 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100193 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200194
195 sign unplace 41
196 let a=execute('sign place')
197 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200198endfunc
199
200func Test_sign_completion()
201 sign define Sign1 text=x
202 sign define Sign2 text=y
203
204 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
205 call assert_equal('"sign define jump list place undefine unplace', @:)
206
207 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
208 call assert_equal('"sign define Sign icon= linehl= text= texthl=', @:)
209
210 call feedkeys(":sign define Sign linehl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100211 call assert_equal('"sign define Sign linehl=SpellBad SpellCap ' .
212 \ 'SpellLocal SpellRare', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200213
Bram Moolenaar3678f652019-02-17 14:50:25 +0100214 call feedkeys(":sign define Sign texthl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
215 call assert_equal('"sign define Sign texthl=SpellBad SpellCap ' .
216 \ 'SpellLocal SpellRare', @:)
217
218 call writefile(repeat(["Sun is shining"], 30), "XsignOne")
219 call writefile(repeat(["Sky is blue"], 30), "XsignTwo")
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200220 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
221 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200222
Bram Moolenaar3678f652019-02-17 14:50:25 +0100223 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200224 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
225 call assert_equal('"sign undefine Sign1 Sign2', @:)
226
227 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100228 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
229 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200230
231 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
232 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
233
Bram Moolenaar3678f652019-02-17 14:50:25 +0100234 edit XsignOne
235 sign place 1 name=Sign1 line=5
236 sign place 1 name=Sign1 group=g1 line=10
237 edit XsignTwo
238 sign place 1 name=Sign2 group=g2 line=15
239
240 " Test for completion of group= and file= arguments to ':sign place'
241 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
242 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
243 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
244 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
245
246 " Test for completion of arguments to 'sign place' without sign identifier
247 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
248 call assert_equal('"sign place buffer= file= group=', @:)
249 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
250 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
251 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
252 call assert_equal('"sign place group=g1 g2', @:)
253 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
254 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
255
256 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200257 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100258 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100259 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
260 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
261 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
262 call assert_equal('"sign unplace 1 group=g1 g2', @:)
263 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
264 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200265
Bram Moolenaar3678f652019-02-17 14:50:25 +0100266 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200267 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
268 call assert_equal('"sign list Sign1 Sign2', @:)
269
Bram Moolenaar3678f652019-02-17 14:50:25 +0100270 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200271 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100272 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100273 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
274 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
275 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
276 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200277
Bram Moolenaar3678f652019-02-17 14:50:25 +0100278 " Error cases
279 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
280 call assert_equal('"sign here', @:)
281 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
282 call assert_equal("\"sign define Sign here=\<C-A>", @:)
283 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
284 call assert_equal("\"sign place 1 here=\<C-A>", @:)
285 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
286 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
287 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
288 call assert_equal("\"sign here there\<C-A>", @:)
289 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
290 call assert_equal("\"sign here there=\<C-A>", @:)
291
292 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200293 sign undefine Sign1
294 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100295 enew
296 call delete('XsignOne')
297 call delete('XsignTwo')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200298endfunc
299
300func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100301 sign define Sign1 text=x
302
Bram Moolenaar09de1752016-08-08 22:26:48 +0200303 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200304 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200305 call assert_fails('sign xxx', 'E160:')
306 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200307 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200308 call assert_fails('sign undefine', 'E156:')
309 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200310 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100311 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
312 call assert_fails('sign place buffer=999', 'E158:')
313 call assert_fails('sign jump buffer=999', 'E158:')
314 call assert_fails('sign jump 1 file=', 'E158:')
315 call assert_fails('sign jump 1 group=', 'E474:')
316 call assert_fails('sign jump 1 name=', 'E474:')
317 call assert_fails('sign jump 1 name=Sign1', 'E474:')
318 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200319 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100320 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100321 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
322 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100323 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100324 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
325 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100326 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100327 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
328 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100329 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100330 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
331 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100332 " Sign identifier and '*' for :sign unplace
333 call assert_fails("sign unplace 2 *", 'E474:')
334 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100335 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
336 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100337 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100338 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
339 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100340 call assert_fails("sign unplace 1 xxx", 'E474:')
341 call assert_fails("sign unplace * xxx", 'E474:')
342 call assert_fails("sign unplace xxx", 'E474:')
343 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100344 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100345 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100346 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100347 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100348 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100349 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100350 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100351 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100352 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100353 " Placing a sign with only sign identifier
354 call assert_fails("sign place 2", 'E474:')
355 " Placing a sign with only a name
356 call assert_fails("sign place abc", 'E474:')
357 " Placing a sign with only line number
358 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100359 " Placing a sign with only sign group
360 call assert_fails("sign place 5 group=g1", 'E474:')
361 call assert_fails("sign place 5 group=*", 'E474:')
362 " Placing a sign with only sign priority
363 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100364
365 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200366endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200367
368func Test_sign_delete_buffer()
369 new
370 sign define Sign text=x
371 let bufnr = bufnr('%')
372 new
373 exe 'bd ' . bufnr
374 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
375 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
376 sign unplace 61
377 sign undefine Sign
378endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100379
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100380" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100381func Test_sign_funcs()
382 " Remove all the signs
383 call sign_unplace('*')
384 call sign_undefine()
385
386 " Tests for sign_define()
387 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
388 call assert_equal(0, sign_define("sign1", attr))
389 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error',
390 \ 'linehl' : 'Search', 'text' : '=>'}], sign_getdefined())
391
392 " Define a new sign without attributes and then update it
393 call sign_define("sign2")
394 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
395 \ 'icon' : 'sign2.ico'}
396 try
397 call sign_define("sign2", attr)
398 catch /E255:/
399 " ignore error: E255: Couldn't read in sign data!
400 " This error can happen when running in gui.
401 endtry
402 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
403 \ 'linehl' : 'DiffAdd', 'text' : '!!', 'icon' : 'sign2.ico'}],
404 \ sign_getdefined("sign2"))
405
406 " Test for a sign name with digits
407 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
408 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
409 \ sign_getdefined(0002))
410 call sign_undefine(0002)
411
412 " Tests for invalid arguments to sign_define()
413 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
414 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200415 call assert_fails('call sign_define({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100416 call assert_fails('call sign_define("sign6", [])', 'E715:')
417
418 " Tests for sign_getdefined()
419 call assert_equal([], sign_getdefined("none"))
420 call assert_fails('call sign_getdefined({})', 'E731:')
421
422 " Tests for sign_place()
423 call writefile(repeat(["Sun is shining"], 30), "Xsign")
424 edit Xsign
425
426 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
427 \ {'lnum' : 20}))
428 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
429 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
430 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
431 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
432 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
433 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100434 \ sign_getplaced('%', {'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100435 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
436 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
437 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100438 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100439
440 " Tests for invalid arguments to sign_place()
441 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
442 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
443 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])',
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200444 \ 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100445 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
446 \ {"lnum" : 30})', 'E474:')
447 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
448 \ {"lnum" : 30})', 'E155:')
449 call assert_fails('call sign_place(10, "", "", "Xsign",
450 \ {"lnum" : 30})', 'E155:')
451 call assert_fails('call sign_place(10, "", [], "Xsign",
452 \ {"lnum" : 30})', 'E730:')
453 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
454 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100455 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100456 \ 'E158:')
457 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
458 \ 'E158:')
459 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200460 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100461 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200462 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100463 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200464 \ {"lnum" : []})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100465 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
466
467 " Tests for sign_getplaced()
468 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
469 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
470 \ 'priority' : 10}]}],
471 \ sign_getplaced(bufnr('Xsign')))
472 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
473 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
474 \ 'priority' : 10}]}],
475 \ sign_getplaced())
476 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100477 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100478 call assert_fails('call sign_getplaced(-1)', 'E158:')
479 call assert_fails('call sign_getplaced("Xsign", [])', 'E715:')
480 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
481 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
482 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
483 \ 'E745:')
484 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
485 \ sign_getplaced('Xsign', {'id' : 44}))
486 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
487 \ 'E745:')
488
489 " Tests for sign_unplace()
490 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
491 call assert_equal(0, sign_unplace('',
492 \ {'id' : 20, 'buffer' : 'Xsign'}))
493 call assert_equal(-1, sign_unplace('',
494 \ {'id' : 30, 'buffer' : 'Xsign'}))
495 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
496 call assert_fails("call sign_unplace('',
497 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
498 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100499 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100500 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100501 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100502 call assert_fails("call sign_unplace('g1', 'mySign')", 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100503
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200504 call sign_unplace('*')
505
506 " Test for modifying a placed sign
507 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
508 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
509 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
510 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
511 \ 'priority' : 10}]}],
512 \ sign_getplaced())
513
Bram Moolenaar162b7142018-12-21 15:17:36 +0100514 " Tests for sign_undefine()
515 call assert_equal(0, sign_undefine("sign1"))
516 call assert_equal([], sign_getdefined("sign1"))
517 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200518 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100519
Bram Moolenaar42aff462019-08-21 13:20:29 +0200520 " Test for using '.' as the line number for sign_place()
521 call sign_define("sign1", attr)
522 call cursor(22, 1)
523 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
524 \ {'lnum' : '.'}))
525 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
526 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
527 \ 'priority' : 10}]}],
528 \ sign_getplaced('%', {'lnum' : 22}))
529
Bram Moolenaar162b7142018-12-21 15:17:36 +0100530 call delete("Xsign")
531 call sign_unplace('*')
532 call sign_undefine()
533 enew | only
534endfunc
535
536" Tests for sign groups
537func Test_sign_group()
538 enew | only
539 " Remove all the signs
540 call sign_unplace('*')
541 call sign_undefine()
542
543 call writefile(repeat(["Sun is shining"], 30), "Xsign")
544
545 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
546 call assert_equal(0, sign_define("sign1", attr))
547
548 edit Xsign
549 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100550
551 " Error case
552 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
553 \ {'lnum' : 30})", 'E730:')
554
555 " place three signs with the same identifier. One in the global group and
556 " others in the named groups
557 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
558 \ {'lnum' : 10}))
559 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
560 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
561
562 " Test for sign_getplaced() with group
563 let s = sign_getplaced('Xsign')
564 call assert_equal(1, len(s[0].signs))
565 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100566 let s = sign_getplaced(bnum, {'group' : ''})
567 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
568 \ 'priority' : 10}], s[0].signs)
569 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100570 let s = sign_getplaced(bnum, {'group' : 'g2'})
571 call assert_equal('g2', s[0].signs[0].group)
572 let s = sign_getplaced(bnum, {'group' : 'g3'})
573 call assert_equal([], s[0].signs)
574 let s = sign_getplaced(bnum, {'group' : '*'})
575 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
576 \ 'priority' : 10},
577 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
578 \ 'priority' : 10},
579 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
580 \ 'priority' : 10}],
581 \ s[0].signs)
582
583 " Test for sign_getplaced() with id
584 let s = sign_getplaced(bnum, {'id' : 5})
585 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
586 \ 'priority' : 10}],
587 \ s[0].signs)
588 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
589 call assert_equal(
590 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
591 \ 'priority' : 10}],
592 \ s[0].signs)
593 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
594 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
595 \ 'priority' : 10},
596 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
597 \ 'priority' : 10},
598 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
599 \ 'priority' : 10}],
600 \ s[0].signs)
601 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
602 call assert_equal([], s[0].signs)
603
604 " Test for sign_getplaced() with lnum
605 let s = sign_getplaced(bnum, {'lnum' : 20})
606 call assert_equal([], s[0].signs)
607 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
608 call assert_equal(
609 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
610 \ 'priority' : 10}],
611 \ s[0].signs)
612 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
613 call assert_equal(
614 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
615 \ 'priority' : 10}],
616 \ s[0].signs)
617 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
618 call assert_equal([], s[0].signs)
619
620 " Error case
621 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
622 \ 'E730:')
623
624 " Clear the sign in global group
625 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
626 let s = sign_getplaced(bnum, {'group' : '*'})
627 call assert_equal([
628 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
629 \ 'priority' : 10},
630 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
631 \ 'priority' : 10}],
632 \ s[0].signs)
633
634 " Clear the sign in one of the groups
635 call sign_unplace('g1', {'buffer' : 'Xsign'})
636 let s = sign_getplaced(bnum, {'group' : '*'})
637 call assert_equal([
638 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
639 \ 'priority' : 10}],
640 \ s[0].signs)
641
642 " Clear all the signs from the buffer
643 call sign_unplace('*', {'buffer' : bnum})
644 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
645
646 " Clear sign across groups using an identifier
647 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
648 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
649 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
650 call assert_equal(0, sign_unplace('*', {'id' : 25}))
651 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
652
653 " Error case
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200654 call assert_fails("call sign_unplace({})", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100655
656 " Place a sign in the global group and try to delete it using a group
657 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
658 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
659
660 " Place signs in multiple groups and delete all the signs in one of the
661 " group
662 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
663 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
664 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
665 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
666 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
667 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
668 call assert_equal(0, sign_unplace('g1'))
669 let s = sign_getplaced(bnum, {'group' : 'g1'})
670 call assert_equal([], s[0].signs)
671 let s = sign_getplaced(bnum)
672 call assert_equal(2, len(s[0].signs))
673 let s = sign_getplaced(bnum, {'group' : 'g2'})
674 call assert_equal('g2', s[0].signs[0].group)
675 call assert_equal(0, sign_unplace('', {'id' : 5}))
676 call assert_equal(0, sign_unplace('', {'id' : 6}))
677 let s = sign_getplaced(bnum, {'group' : 'g2'})
678 call assert_equal('g2', s[0].signs[0].group)
679 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
680
681 call sign_unplace('*')
682
683 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100684 sign place 5 line=10 name=sign1 file=Xsign
685 sign place 5 group=g1 line=10 name=sign1 file=Xsign
686 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100687
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100688 " Tests for the ':sign place' command
689
690 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100691 let a = execute('sign place file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100692 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100693 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100694
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100695 " :sign place group={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100696 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100697 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100698 \ " line=10 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100699
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100700 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100701 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100702 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100703 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
704 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
705 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100706
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100707 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100708 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100709 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
710
711 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100712 let bnum = bufnr('Xsign')
713 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
714 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
715 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
716
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100717 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100718 let a = execute('sign place buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100719 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100720 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100721
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100722 " :sign place group={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100723 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100724 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100725 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100726
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100727 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100728 let a = execute('sign place group=* buffer=' . bnum)
729 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100730 \ " line=10 id=5 name=sign1 priority=10\n" .
731 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
732 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100733
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100734 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100735 let a = execute('sign place group=xyz buffer=' . bnum)
736 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
737
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100738 " :sign place
739 let a = execute('sign place')
740 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100741 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100742
Bram Moolenaarb589f952019-01-07 22:10:00 +0100743 " Place signs in more than one buffer and list the signs
744 split foo
745 set buftype=nofile
746 sign place 25 line=76 name=sign1 priority=99 file=foo
747 let a = execute('sign place')
748 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
749 \ " line=10 id=5 name=sign1 priority=10\n" .
750 \ "Signs for foo:\n" .
751 \ " line=76 id=25 name=sign1 priority=99\n", a)
752 close
753 bwipe foo
754
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100755 " :sign place group={group}
756 let a = execute('sign place group=g1')
757 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100758 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100759
760 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100761 let a = execute('sign place group=*')
762 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100763 \ " line=10 id=5 name=sign1 priority=10\n" .
764 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
765 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100766
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100767 " Test for ':sign jump' command with groups
768 sign jump 5 group=g1 file=Xsign
769 call assert_equal(11, line('.'))
770 call assert_equal('Xsign', bufname(''))
771 sign jump 5 group=g2 file=Xsign
772 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100773
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100774 " Test for :sign jump command without the filename or buffer
775 sign jump 5
776 call assert_equal(10, line('.'))
777 sign jump 5 group=g1
778 call assert_equal(11, line('.'))
779
Bram Moolenaar162b7142018-12-21 15:17:36 +0100780 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100781 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100782
783 call delete("Xsign")
784 call sign_unplace('*')
785 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100786 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100787endfunc
788
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100789" Place signs used for ":sign unplace" command test
790func Place_signs_for_test()
791 call sign_unplace('*')
792
793 sign place 3 line=10 name=sign1 file=Xsign1
794 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
795 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
796 sign place 4 line=15 name=sign1 file=Xsign1
797 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
798 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
799 sign place 5 line=20 name=sign1 file=Xsign2
800 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
801 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
802 sign place 6 line=25 name=sign1 file=Xsign2
803 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
804 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
805endfunc
806
807" Place multiple signs in a single line for test
808func Place_signs_at_line_for_test()
809 call sign_unplace('*')
810 sign place 3 line=13 name=sign1 file=Xsign1
811 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
812 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
813 sign place 4 line=13 name=sign1 file=Xsign1
814 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
815 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
816endfunc
817
818" Tests for the ':sign unplace' command
819func Test_sign_unplace()
820 enew | only
821 " Remove all the signs
822 call sign_unplace('*')
823 call sign_undefine()
824
825 " Create two files and define signs
826 call writefile(repeat(["Sun is shining"], 30), "Xsign1")
827 call writefile(repeat(["It is beautiful"], 30), "Xsign2")
828
829 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
830 call sign_define("sign1", attr)
831
832 edit Xsign1
833 let bnum1 = bufnr('%')
834 split Xsign2
835 let bnum2 = bufnr('%')
836
837 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
838 \ 'priority' : 10},
839 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
840 \ 'priority' : 10},
841 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
842 \ 'priority' : 10},
843 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
844 \ 'priority' : 10},
845 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
846 \ 'priority' : 10},
847 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
848 \ 'priority' : 10},]
849 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
850 \ 'priority' : 10},
851 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
852 \ 'priority' : 10},
853 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
854 \ 'priority' : 10},
855 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
856 \ 'priority' : 10},
857 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
858 \ 'priority' : 10},
859 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
860 \ 'priority' : 10},]
861
862 " Test for :sign unplace {id} file={fname}
863 call Place_signs_for_test()
864 sign unplace 3 file=Xsign1
865 sign unplace 6 file=Xsign2
866 call assert_equal(
867 \ filter(copy(signs1),
868 \ {idx, val -> val.id != 3 || val.group != ''}),
869 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
870 call assert_equal(
871 \ filter(copy(signs2),
872 \ {idx, val -> val.id != 6 || val.group != ''}),
873 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
874
875 " Test for :sign unplace {id} group={group} file={fname}
876 call Place_signs_for_test()
877 sign unplace 4 group=g1 file=Xsign1
878 sign unplace 5 group=g2 file=Xsign2
879 call assert_equal(
880 \ filter(copy(signs1),
881 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
882 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
883 call assert_equal(
884 \ filter(copy(signs2),
885 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
886 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
887
888 " Test for :sign unplace {id} group=* file={fname}
889 call Place_signs_for_test()
890 sign unplace 3 group=* file=Xsign1
891 sign unplace 6 group=* file=Xsign2
892 call assert_equal(
893 \ filter(copy(signs1),
894 \ {idx, val -> val.id != 3}),
895 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
896 call assert_equal(
897 \ filter(copy(signs2),
898 \ {idx, val -> val.id != 6}),
899 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
900
901 " Test for :sign unplace * file={fname}
902 call Place_signs_for_test()
903 sign unplace * file=Xsign1
904 call assert_equal(
905 \ filter(copy(signs1),
906 \ {idx, val -> val.group != ''}),
907 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
908 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
909
910 " Test for :sign unplace * group={group} file={fname}
911 call Place_signs_for_test()
912 sign unplace * group=g1 file=Xsign1
913 sign unplace * group=g2 file=Xsign2
914 call assert_equal(
915 \ filter(copy(signs1),
916 \ {idx, val -> val.group != 'g1'}),
917 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
918 call assert_equal(
919 \ filter(copy(signs2),
920 \ {idx, val -> val.group != 'g2'}),
921 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
922
923 " Test for :sign unplace * group=* file={fname}
924 call Place_signs_for_test()
925 sign unplace * group=* file=Xsign2
926 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
927 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
928
929 " Test for :sign unplace {id} buffer={nr}
930 call Place_signs_for_test()
931 exe 'sign unplace 3 buffer=' . bnum1
932 exe 'sign unplace 6 buffer=' . bnum2
933 call assert_equal(
934 \ filter(copy(signs1),
935 \ {idx, val -> val.id != 3 || val.group != ''}),
936 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
937 call assert_equal(
938 \ filter(copy(signs2),
939 \ {idx, val -> val.id != 6 || val.group != ''}),
940 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
941
942 " Test for :sign unplace {id} group={group} buffer={nr}
943 call Place_signs_for_test()
944 exe 'sign unplace 4 group=g1 buffer=' . bnum1
945 exe 'sign unplace 5 group=g2 buffer=' . bnum2
946 call assert_equal(
947 \ filter(copy(signs1),
948 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
949 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
950 call assert_equal(
951 \ filter(copy(signs2),
952 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
953 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
954
955 " Test for :sign unplace {id} group=* buffer={nr}
956 call Place_signs_for_test()
957 exe 'sign unplace 3 group=* buffer=' . bnum1
958 exe 'sign unplace 6 group=* buffer=' . bnum2
959 call assert_equal(
960 \ filter(copy(signs1),
961 \ {idx, val -> val.id != 3}),
962 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
963 call assert_equal(
964 \ filter(copy(signs2),
965 \ {idx, val -> val.id != 6}),
966 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
967
968 " Test for :sign unplace * buffer={nr}
969 call Place_signs_for_test()
970 exe 'sign unplace * buffer=' . bnum1
971 call assert_equal(
972 \ filter(copy(signs1),
973 \ {idx, val -> val.group != ''}),
974 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
975 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
976
977 " Test for :sign unplace * group={group} buffer={nr}
978 call Place_signs_for_test()
979 exe 'sign unplace * group=g1 buffer=' . bnum1
980 exe 'sign unplace * group=g2 buffer=' . bnum2
981 call assert_equal(
982 \ filter(copy(signs1),
983 \ {idx, val -> val.group != 'g1'}),
984 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
985 call assert_equal(
986 \ filter(copy(signs2),
987 \ {idx, val -> val.group != 'g2'}),
988 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
989
990 " Test for :sign unplace * group=* buffer={nr}
991 call Place_signs_for_test()
992 exe 'sign unplace * group=* buffer=' . bnum2
993 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
994 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
995
996 " Test for :sign unplace {id}
997 call Place_signs_for_test()
998 sign unplace 4
999 sign unplace 6
1000 call assert_equal(
1001 \ filter(copy(signs1),
1002 \ {idx, val -> val.id != 4 || val.group != ''}),
1003 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1004 call assert_equal(
1005 \ filter(copy(signs2),
1006 \ {idx, val -> val.id != 6 || val.group != ''}),
1007 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1008
1009 " Test for :sign unplace {id} group={group}
1010 call Place_signs_for_test()
1011 sign unplace 4 group=g1
1012 sign unplace 6 group=g2
1013 call assert_equal(
1014 \ filter(copy(signs1),
1015 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1016 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1017 call assert_equal(
1018 \ filter(copy(signs2),
1019 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1020 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1021
1022 " Test for :sign unplace {id} group=*
1023 call Place_signs_for_test()
1024 sign unplace 3 group=*
1025 sign unplace 5 group=*
1026 call assert_equal(
1027 \ filter(copy(signs1),
1028 \ {idx, val -> val.id != 3}),
1029 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1030 call assert_equal(
1031 \ filter(copy(signs2),
1032 \ {idx, val -> val.id != 5}),
1033 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1034
1035 " Test for :sign unplace *
1036 call Place_signs_for_test()
1037 sign unplace *
1038 call assert_equal(
1039 \ filter(copy(signs1),
1040 \ {idx, val -> val.group != ''}),
1041 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1042 call assert_equal(
1043 \ filter(copy(signs2),
1044 \ {idx, val -> val.group != ''}),
1045 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1046
1047 " Test for :sign unplace * group={group}
1048 call Place_signs_for_test()
1049 sign unplace * group=g1
1050 call assert_equal(
1051 \ filter(copy(signs1),
1052 \ {idx, val -> val.group != 'g1'}),
1053 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1054 call assert_equal(
1055 \ filter(copy(signs2),
1056 \ {idx, val -> val.group != 'g1'}),
1057 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1058
1059 " Test for :sign unplace * group=*
1060 call Place_signs_for_test()
1061 sign unplace * group=*
1062 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1063 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1064
1065 " Negative test cases
1066 call Place_signs_for_test()
1067 sign unplace 3 group=xy file=Xsign1
1068 sign unplace * group=xy file=Xsign1
1069 silent! sign unplace * group=* file=FileNotPresent
1070 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1071 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1072
1073 " Tests for removing sign at the current cursor position
1074
1075 " Test for ':sign unplace'
1076 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1077 \ 'priority' : 10},
1078 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1079 \ 'priority' : 10},
1080 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1081 \ 'priority' : 10},
1082 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1083 \ 'priority' : 10},
1084 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1085 \ 'priority' : 10},
1086 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1087 \ 'priority' : 10},]
1088 exe bufwinnr('Xsign1') . 'wincmd w'
1089 call cursor(13, 1)
1090
1091 " Should remove only one sign in the global group
1092 call Place_signs_at_line_for_test()
1093 sign unplace
1094 call assert_equal(
1095 \ filter(copy(signs1),
1096 \ {idx, val -> val.id != 4 || val.group != ''}),
1097 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1098 " Should remove the second sign in the global group
1099 sign unplace
1100 call assert_equal(
1101 \ filter(copy(signs1),
1102 \ {idx, val -> val.group != ''}),
1103 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1104
1105 " Test for ':sign unplace group={group}'
1106 call Place_signs_at_line_for_test()
1107 " Should remove only one sign in group g1
1108 sign unplace group=g1
1109 call assert_equal(
1110 \ filter(copy(signs1),
1111 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1112 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1113 sign unplace group=g2
1114 call assert_equal(
1115 \ filter(copy(signs1),
1116 \ {idx, val -> val.id != 4 || val.group == ''}),
1117 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1118
1119 " Test for ':sign unplace group=*'
1120 call Place_signs_at_line_for_test()
1121 sign unplace group=*
1122 sign unplace group=*
1123 sign unplace group=*
1124 call assert_equal(
1125 \ filter(copy(signs1),
1126 \ {idx, val -> val.id != 4}),
1127 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1128 sign unplace group=*
1129 sign unplace group=*
1130 sign unplace group=*
1131 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1132
1133 call sign_unplace('*')
1134 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001135 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001136 call delete("Xsign1")
1137 call delete("Xsign2")
1138endfunc
1139
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001140" Tests for auto-generating the sign identifier.
1141func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001142 enew | only
1143 call sign_unplace('*')
1144 call sign_undefine()
1145
1146 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1147 call assert_equal(0, sign_define("sign1", attr))
1148
1149 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1150 edit Xsign
1151
1152 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1153 \ {'lnum' : 10}))
1154 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1155 \ {'lnum' : 12}))
1156 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1157 \ {'lnum' : 14}))
1158 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001159 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001160 \ {'lnum' : 12}))
1161
1162 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1163 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001164 " Check for the next generated sign id in this group
1165 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1166 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001167 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1168 call assert_equal(10,
1169 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1170
1171 call delete("Xsign")
1172 call sign_unplace('*')
1173 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001174 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001175endfunc
1176
1177" Test for sign priority
1178func Test_sign_priority()
1179 enew | only
1180 call sign_unplace('*')
1181 call sign_undefine()
1182
1183 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1184 call sign_define("sign1", attr)
1185 call sign_define("sign2", attr)
1186 call sign_define("sign3", attr)
1187
1188 " Place three signs with different priority in the same line
1189 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1190 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001191
1192 call sign_place(1, 'g1', 'sign1', 'Xsign',
1193 \ {'lnum' : 11, 'priority' : 50})
1194 call sign_place(2, 'g2', 'sign2', 'Xsign',
1195 \ {'lnum' : 11, 'priority' : 100})
1196 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1197 let s = sign_getplaced('Xsign', {'group' : '*'})
1198 call assert_equal([
1199 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1200 \ 'priority' : 100},
1201 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1202 \ 'priority' : 50},
1203 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1204 \ 'priority' : 10}],
1205 \ s[0].signs)
1206
Bram Moolenaar64416122019-06-07 21:37:13 +02001207 call sign_unplace('*')
1208
1209 " Three signs on different lines with changing priorities
1210 call sign_place(1, '', 'sign1', 'Xsign',
1211 \ {'lnum' : 11, 'priority' : 50})
1212 call sign_place(2, '', 'sign2', 'Xsign',
1213 \ {'lnum' : 12, 'priority' : 60})
1214 call sign_place(3, '', 'sign3', 'Xsign',
1215 \ {'lnum' : 13, 'priority' : 70})
1216 call sign_place(2, '', 'sign2', 'Xsign',
1217 \ {'lnum' : 12, 'priority' : 40})
1218 call sign_place(3, '', 'sign3', 'Xsign',
1219 \ {'lnum' : 13, 'priority' : 30})
1220 call sign_place(1, '', 'sign1', 'Xsign',
1221 \ {'lnum' : 11, 'priority' : 50})
1222 let s = sign_getplaced('Xsign', {'group' : '*'})
1223 call assert_equal([
1224 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1225 \ 'priority' : 50},
1226 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1227 \ 'priority' : 40},
1228 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1229 \ 'priority' : 30}],
1230 \ s[0].signs)
1231
1232 call sign_unplace('*')
1233
1234 " Two signs on the same line with changing priorities
1235 call sign_place(1, '', 'sign1', 'Xsign',
1236 \ {'lnum' : 4, 'priority' : 20})
1237 call sign_place(2, '', 'sign2', 'Xsign',
1238 \ {'lnum' : 4, 'priority' : 30})
1239 let s = sign_getplaced('Xsign', {'group' : '*'})
1240 call assert_equal([
1241 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1242 \ 'priority' : 30},
1243 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1244 \ 'priority' : 20}],
1245 \ s[0].signs)
1246 " Change the priority of the last sign to highest
1247 call sign_place(1, '', 'sign1', 'Xsign',
1248 \ {'lnum' : 4, 'priority' : 40})
1249 let s = sign_getplaced('Xsign', {'group' : '*'})
1250 call assert_equal([
1251 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1252 \ 'priority' : 40},
1253 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1254 \ 'priority' : 30}],
1255 \ s[0].signs)
1256 " Change the priority of the first sign to lowest
1257 call sign_place(1, '', 'sign1', 'Xsign',
1258 \ {'lnum' : 4, 'priority' : 25})
1259 let s = sign_getplaced('Xsign', {'group' : '*'})
1260 call assert_equal([
1261 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1262 \ 'priority' : 30},
1263 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1264 \ 'priority' : 25}],
1265 \ s[0].signs)
1266 call sign_place(1, '', 'sign1', 'Xsign',
1267 \ {'lnum' : 4, 'priority' : 45})
1268 call sign_place(2, '', 'sign2', 'Xsign',
1269 \ {'lnum' : 4, 'priority' : 55})
1270 let s = sign_getplaced('Xsign', {'group' : '*'})
1271 call assert_equal([
1272 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1273 \ 'priority' : 55},
1274 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1275 \ 'priority' : 45}],
1276 \ s[0].signs)
1277
1278 call sign_unplace('*')
1279
1280 " Three signs on the same line with changing priorities
1281 call sign_place(1, '', 'sign1', 'Xsign',
1282 \ {'lnum' : 4, 'priority' : 40})
1283 call sign_place(2, '', 'sign2', 'Xsign',
1284 \ {'lnum' : 4, 'priority' : 30})
1285 call sign_place(3, '', 'sign3', 'Xsign',
1286 \ {'lnum' : 4, 'priority' : 20})
1287 let s = sign_getplaced('Xsign', {'group' : '*'})
1288 call assert_equal([
1289 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1290 \ 'priority' : 40},
1291 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1292 \ 'priority' : 30},
1293 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1294 \ 'priority' : 20}],
1295 \ s[0].signs)
1296
1297 " Change the priority of the middle sign to the highest
1298 call sign_place(2, '', 'sign2', 'Xsign',
1299 \ {'lnum' : 4, 'priority' : 50})
1300 let s = sign_getplaced('Xsign', {'group' : '*'})
1301 call assert_equal([
1302 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1303 \ 'priority' : 50},
1304 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1305 \ 'priority' : 40},
1306 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1307 \ 'priority' : 20}],
1308 \ s[0].signs)
1309
1310 " Change the priority of the middle sign to the lowest
1311 call sign_place(1, '', 'sign1', 'Xsign',
1312 \ {'lnum' : 4, 'priority' : 15})
1313 let s = sign_getplaced('Xsign', {'group' : '*'})
1314 call assert_equal([
1315 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1316 \ 'priority' : 50},
1317 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1318 \ 'priority' : 20},
1319 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1320 \ 'priority' : 15}],
1321 \ s[0].signs)
1322
1323 " Change the priority of the last sign to the highest
1324 call sign_place(1, '', 'sign1', 'Xsign',
1325 \ {'lnum' : 4, 'priority' : 55})
1326 let s = sign_getplaced('Xsign', {'group' : '*'})
1327 call assert_equal([
1328 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1329 \ 'priority' : 55},
1330 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1331 \ 'priority' : 50},
1332 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1333 \ 'priority' : 20}],
1334 \ s[0].signs)
1335
1336 " Change the priority of the first sign to the lowest
1337 call sign_place(1, '', 'sign1', 'Xsign',
1338 \ {'lnum' : 4, 'priority' : 15})
1339 let s = sign_getplaced('Xsign', {'group' : '*'})
1340 call assert_equal([
1341 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1342 \ 'priority' : 50},
1343 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1344 \ 'priority' : 20},
1345 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1346 \ 'priority' : 15}],
1347 \ s[0].signs)
1348
1349 call sign_unplace('*')
1350
1351 " Three signs on the same line with changing priorities along with other
1352 " signs
1353 call sign_place(1, '', 'sign1', 'Xsign',
1354 \ {'lnum' : 2, 'priority' : 10})
1355 call sign_place(2, '', 'sign1', 'Xsign',
1356 \ {'lnum' : 4, 'priority' : 30})
1357 call sign_place(3, '', 'sign2', 'Xsign',
1358 \ {'lnum' : 4, 'priority' : 20})
1359 call sign_place(4, '', 'sign3', 'Xsign',
1360 \ {'lnum' : 4, 'priority' : 25})
1361 call sign_place(5, '', 'sign2', 'Xsign',
1362 \ {'lnum' : 6, 'priority' : 80})
1363 let s = sign_getplaced('Xsign', {'group' : '*'})
1364 call assert_equal([
1365 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1366 \ 'priority' : 10},
1367 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1368 \ 'priority' : 30},
1369 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1370 \ 'priority' : 25},
1371 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1372 \ 'priority' : 20},
1373 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1374 \ 'priority' : 80}],
1375 \ s[0].signs)
1376
1377 " Change the priority of the first sign to lowest
1378 call sign_place(2, '', 'sign1', 'Xsign',
1379 \ {'lnum' : 4, 'priority' : 15})
1380 let s = sign_getplaced('Xsign', {'group' : '*'})
1381 call assert_equal([
1382 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1383 \ 'priority' : 10},
1384 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1385 \ 'priority' : 25},
1386 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1387 \ 'priority' : 20},
1388 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1389 \ 'priority' : 15},
1390 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1391 \ 'priority' : 80}],
1392 \ s[0].signs)
1393
1394 " Change the priority of the last sign to highest
1395 call sign_place(2, '', 'sign1', 'Xsign',
1396 \ {'lnum' : 4, 'priority' : 30})
1397 let s = sign_getplaced('Xsign', {'group' : '*'})
1398 call assert_equal([
1399 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1400 \ 'priority' : 10},
1401 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1402 \ 'priority' : 30},
1403 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1404 \ 'priority' : 25},
1405 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1406 \ 'priority' : 20},
1407 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1408 \ 'priority' : 80}],
1409 \ s[0].signs)
1410
1411 " Change the priority of the middle sign to lowest
1412 call sign_place(4, '', 'sign3', 'Xsign',
1413 \ {'lnum' : 4, 'priority' : 15})
1414 let s = sign_getplaced('Xsign', {'group' : '*'})
1415 call assert_equal([
1416 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1417 \ 'priority' : 10},
1418 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1419 \ 'priority' : 30},
1420 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1421 \ 'priority' : 20},
1422 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1423 \ 'priority' : 15},
1424 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1425 \ 'priority' : 80}],
1426 \ s[0].signs)
1427
1428 " Change the priority of the middle sign to highest
1429 call sign_place(3, '', 'sign2', 'Xsign',
1430 \ {'lnum' : 4, 'priority' : 35})
1431 let s = sign_getplaced('Xsign', {'group' : '*'})
1432 call assert_equal([
1433 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1434 \ 'priority' : 10},
1435 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1436 \ 'priority' : 35},
1437 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1438 \ 'priority' : 30},
1439 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1440 \ 'priority' : 15},
1441 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1442 \ 'priority' : 80}],
1443 \ s[0].signs)
1444
1445 call sign_unplace('*')
1446
1447 " Multiple signs with the same priority on the same line
1448 call sign_place(1, '', 'sign1', 'Xsign',
1449 \ {'lnum' : 4, 'priority' : 20})
1450 call sign_place(2, '', 'sign2', 'Xsign',
1451 \ {'lnum' : 4, 'priority' : 20})
1452 call sign_place(3, '', 'sign3', 'Xsign',
1453 \ {'lnum' : 4, 'priority' : 20})
1454 let s = sign_getplaced('Xsign', {'group' : '*'})
1455 call assert_equal([
1456 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1457 \ 'priority' : 20},
1458 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1459 \ 'priority' : 20},
1460 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1461 \ 'priority' : 20}],
1462 \ s[0].signs)
1463 " Place the last sign again with the same priority
1464 call sign_place(1, '', 'sign1', 'Xsign',
1465 \ {'lnum' : 4, 'priority' : 20})
1466 let s = sign_getplaced('Xsign', {'group' : '*'})
1467 call assert_equal([
1468 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1469 \ 'priority' : 20},
1470 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1471 \ 'priority' : 20},
1472 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1473 \ 'priority' : 20}],
1474 \ s[0].signs)
1475 " Place the first sign again with the same priority
1476 call sign_place(1, '', 'sign1', 'Xsign',
1477 \ {'lnum' : 4, 'priority' : 20})
1478 let s = sign_getplaced('Xsign', {'group' : '*'})
1479 call assert_equal([
1480 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1481 \ 'priority' : 20},
1482 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1483 \ 'priority' : 20},
1484 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1485 \ 'priority' : 20}],
1486 \ s[0].signs)
1487 " Place the middle sign again with the same priority
1488 call sign_place(3, '', 'sign3', 'Xsign',
1489 \ {'lnum' : 4, 'priority' : 20})
1490 let s = sign_getplaced('Xsign', {'group' : '*'})
1491 call assert_equal([
1492 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1493 \ 'priority' : 20},
1494 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1495 \ 'priority' : 20},
1496 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1497 \ 'priority' : 20}],
1498 \ s[0].signs)
1499
1500 call sign_unplace('*')
1501
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001502 " Place multiple signs with same id on a line with different priority
1503 call sign_place(1, '', 'sign1', 'Xsign',
1504 \ {'lnum' : 5, 'priority' : 20})
1505 call sign_place(1, '', 'sign2', 'Xsign',
1506 \ {'lnum' : 5, 'priority' : 10})
1507 let s = sign_getplaced('Xsign', {'lnum' : 5})
1508 call assert_equal([
1509 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1510 \ 'priority' : 10}],
1511 \ s[0].signs)
1512 call sign_place(1, '', 'sign2', 'Xsign',
1513 \ {'lnum' : 5, 'priority' : 5})
1514 let s = sign_getplaced('Xsign', {'lnum' : 5})
1515 call assert_equal([
1516 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1517 \ 'priority' : 5}],
1518 \ s[0].signs)
1519
Bram Moolenaar162b7142018-12-21 15:17:36 +01001520 " Error case
1521 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1522 \ [])", 'E715:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001523 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1524 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001525 call sign_unplace('*')
1526
1527 " Tests for the :sign place command with priority
1528 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1529 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1530 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1531 let a = execute('sign place group=*')
1532 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001533 \ " line=10 id=5 name=sign1 priority=30\n" .
1534 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1535 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001536
1537 " Test for :sign place group={group}
1538 let a = execute('sign place group=g1')
1539 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001540 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001541
1542 call sign_unplace('*')
1543 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001544 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001545 call delete("Xsign")
1546endfunc
1547
1548" Tests for memory allocation failures in sign functions
1549func Test_sign_memfailures()
1550 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1551 edit Xsign
1552
1553 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1554 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1555 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1556 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1557 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1558 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1559 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1560
1561 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1562 call sign_define("sign1", attr)
1563 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1564 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1565
1566 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1567 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1568 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1569 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1570 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1571
1572 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1573 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1574 \ 'E342:')
1575
1576 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1577 call assert_fails('call getbufinfo()', 'E342:')
1578 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1579 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1580 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1581 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1582 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1583
1584 call sign_unplace('*')
1585 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001586 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001587 call delete("Xsign")
1588endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001589
1590" Test for auto-adjusting the line number of a placed sign.
1591func Test_sign_lnum_adjust()
1592 enew! | only!
1593
1594 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001595 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001596 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1597 let l = sign_getplaced(bufnr(''))
1598 call assert_equal(3, l[0].signs[0].lnum)
1599
1600 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001601 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001602 let l = sign_getplaced(bufnr(''))
1603 call assert_equal(6, l[0].signs[0].lnum)
1604
1605 " Delete some lines before the sign and check the sign line number
1606 call deletebufline('%', 1, 2)
1607 let l = sign_getplaced(bufnr(''))
1608 call assert_equal(4, l[0].signs[0].lnum)
1609
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001610 " Insert some lines after the sign and check the sign line number
1611 call append(5, ['DA', 'DB'])
1612 let l = sign_getplaced(bufnr(''))
1613 call assert_equal(4, l[0].signs[0].lnum)
1614
1615 " Delete some lines after the sign and check the sign line number
1616 call deletebufline('', 6, 7)
1617 let l = sign_getplaced(bufnr(''))
1618 call assert_equal(4, l[0].signs[0].lnum)
1619
1620 " Break the undo. Otherwise the undo operation below will undo all the
1621 " changes made by this function.
1622 let &undolevels=&undolevels
1623
1624 " Delete the line with the sign
1625 call deletebufline('', 4)
1626 let l = sign_getplaced(bufnr(''))
1627 call assert_equal(4, l[0].signs[0].lnum)
1628
1629 " Undo the delete operation
1630 undo
1631 let l = sign_getplaced(bufnr(''))
1632 call assert_equal(5, l[0].signs[0].lnum)
1633
1634 " Break the undo
1635 let &undolevels=&undolevels
1636
1637 " Delete few lines at the end of the buffer including the line with the sign
1638 " Sign line number should not change (as it is placed outside of the buffer)
1639 call deletebufline('', 3, 6)
1640 let l = sign_getplaced(bufnr(''))
1641 call assert_equal(5, l[0].signs[0].lnum)
1642
1643 " Undo the delete operation. Sign should be restored to the previous line
1644 undo
1645 let l = sign_getplaced(bufnr(''))
1646 call assert_equal(5, l[0].signs[0].lnum)
1647
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001648 sign unplace * group=*
1649 sign undefine sign1
1650 enew!
1651endfunc
1652
1653" Test for changing the type of a placed sign
1654func Test_sign_change_type()
1655 enew! | only!
1656
1657 sign define sign1 text=#> linehl=Comment
1658 sign define sign2 text=@@ linehl=Comment
1659
1660 call setline(1, ['A', 'B', 'C', 'D'])
1661 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1662 let l = sign_getplaced(bufnr(''))
1663 call assert_equal('sign1', l[0].signs[0].name)
1664 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1665 let l = sign_getplaced(bufnr(''))
1666 call assert_equal('sign2', l[0].signs[0].name)
1667 call sign_place(4, '', 'sign1', '')
1668 let l = sign_getplaced(bufnr(''))
1669 call assert_equal('sign1', l[0].signs[0].name)
1670
1671 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1672 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1673 call assert_equal('sign1', l[0].signs[0].name)
1674 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1675 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1676 call assert_equal('sign2', l[0].signs[0].name)
1677 call sign_place(4, 'g1', 'sign1', '')
1678 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1679 call assert_equal('sign1', l[0].signs[0].name)
1680
1681 sign unplace * group=*
1682 sign undefine sign1
1683 sign undefine sign2
1684 enew!
1685endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001686
1687" Test for the sign_jump() function
1688func Test_sign_jump_func()
1689 enew! | only!
1690
1691 sign define sign1 text=#> linehl=Comment
1692
1693 edit foo
1694 set buftype=nofile
1695 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1696 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1697 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1698 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1699 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1700 split bar
1701 set buftype=nofile
1702 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1703 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1704 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1705 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1706 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1707
1708 let r = sign_jump(5, '', 'foo')
1709 call assert_equal(2, r)
1710 call assert_equal(2, line('.'))
1711 let r = sign_jump(6, 'g1', 'foo')
1712 call assert_equal(5, r)
1713 call assert_equal(5, line('.'))
1714 let r = sign_jump(5, '', 'bar')
1715 call assert_equal(2, r)
1716 call assert_equal(2, line('.'))
1717
1718 " Error cases
1719 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1720 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1721 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1722 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1723 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
1724 call assert_fails('call sign_jump(2, "", {})', 'E158:')
1725 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1726
1727 sign unplace * group=*
1728 sign undefine sign1
1729 enew! | only!
1730endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001731
1732" Test for correct cursor position after the sign column appears or disappears.
1733func Test_sign_cursor_position()
1734 if !CanRunVimInTerminal()
1735 throw 'Skipped: cannot make screendumps'
1736 endif
1737
1738 let lines =<< trim END
1739 call setline(1, [repeat('x', 75), 'mmmm', 'yyyy'])
1740 call cursor(2,1)
1741 sign define s1 texthl=Search text==>
1742 redraw
1743 sign place 10 line=2 name=s1
1744 END
1745 call writefile(lines, 'XtestSigncolumn')
1746 let buf = RunVimInTerminal('-S XtestSigncolumn', {'rows': 6})
1747 call VerifyScreenDump(buf, 'Test_sign_cursor_01', {})
1748
1749 " update cursor position calculation
1750 call term_sendkeys(buf, "lh")
1751 call term_sendkeys(buf, ":sign unplace 10\<CR>")
1752 call VerifyScreenDump(buf, 'Test_sign_cursor_02', {})
1753
1754
1755 " clean up
1756 call StopVimInTerminal(buf)
1757 call delete('XtestSigncolumn')
1758endfunc
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001759
1760" Return the 'len' characters in screen starting from (row,col)
1761func s:ScreenLine(row, col, len)
1762 let s = ''
1763 for i in range(a:len)
1764 let s .= nr2char(screenchar(a:row, a:col + i))
1765 endfor
1766 return s
1767endfunc
1768
1769" Test for 'signcolumn' set to 'number'.
1770func Test_sign_numcol()
1771 new
1772 call append(0, "01234")
1773 " With 'signcolumn' set to 'number', make sure sign is displayed in the
1774 " number column and line number is not displayed.
1775 set numberwidth=2
1776 set number
1777 set signcolumn=number
1778 sign define sign1 text==>
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001779 sign define sign2 text=V
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001780 sign place 10 line=1 name=sign1
1781 redraw!
1782 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1783
1784 " With 'signcolumn' set to 'number', when there is no sign, make sure line
1785 " number is displayed in the number column
1786 sign unplace 10
1787 redraw!
1788 call assert_equal("1 01234", s:ScreenLine(1, 1, 7))
1789
1790 " Disable number column. Check whether sign is displayed in the sign column
1791 set numberwidth=4
1792 set nonumber
1793 sign place 10 line=1 name=sign1
1794 redraw!
1795 call assert_equal("=>01234", s:ScreenLine(1, 1, 7))
1796
1797 " Enable number column. Check whether sign is displayed in the number column
1798 set number
1799 redraw!
Bram Moolenaar4dff4ae2019-06-19 16:31:28 +02001800 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001801
1802 " Disable sign column. Make sure line number is displayed
1803 set signcolumn=no
1804 redraw!
1805 call assert_equal(" 1 01234", s:ScreenLine(1, 1, 9))
1806
1807 " Enable auto sign column. Make sure both sign and line number are displayed
1808 set signcolumn=auto
1809 redraw!
1810 call assert_equal("=> 1 01234", s:ScreenLine(1, 1, 11))
1811
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001812 " Test displaying signs in the number column with width 1
1813 call sign_unplace('*')
1814 call append(1, "abcde")
1815 call append(2, "01234")
1816 " Enable number column with width 1
1817 set number numberwidth=1 signcolumn=auto
1818 redraw!
1819 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1820 " Place a sign and make sure number column width remains the same
1821 sign place 20 line=2 name=sign1
1822 redraw!
1823 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1824 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1825 " Set 'signcolumn' to 'number', make sure the number column width increases
1826 set signcolumn=number
1827 redraw!
1828 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1829 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1830 " Set 'signcolumn' to 'auto', make sure the number column width is 1.
1831 set signcolumn=auto
1832 redraw!
1833 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1834 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1835 " Set 'signcolumn' to 'number', make sure the number column width is 2.
1836 set signcolumn=number
1837 redraw!
1838 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1839 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1840 " Disable 'number' column
1841 set nonumber
1842 redraw!
1843 call assert_equal("=>abcde", s:ScreenLine(2, 1, 7))
1844 call assert_equal(" 01234", s:ScreenLine(3, 1, 7))
1845 " Enable 'number' column
1846 set number
1847 redraw!
1848 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1849 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1850 " Remove the sign and make sure the width of the number column is 1.
1851 call sign_unplace('', {'id' : 20})
1852 redraw!
1853 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1854 " When the first sign is placed with 'signcolumn' set to number, verify that
1855 " the number column width increases
1856 sign place 30 line=1 name=sign1
1857 redraw!
1858 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1859 call assert_equal(" 2 abcde", s:ScreenLine(2, 1, 8))
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001860 " Add sign with multi-byte text
1861 set numberwidth=4
1862 sign place 40 line=2 name=sign2
1863 redraw!
1864 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
1865 call assert_equal(" V abcde", s:ScreenLine(2, 1, 9))
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001866
1867 sign unplace * group=*
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001868 sign undefine sign1
1869 set signcolumn&
1870 set number&
1871 enew! | close
1872endfunc
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001873
1874" Test for managing multiple signs using the sign functions
1875func Test_sign_funcs_multi()
1876 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1877 edit Xsign
1878 let bnum = bufnr('')
1879
1880 " Define multiple signs at once
1881 call assert_equal([0, 0, 0, 0], sign_define([
1882 \ {'name' : 'sign1', 'text' : '=>', 'linehl' : 'Search',
1883 \ 'texthl' : 'Search'},
1884 \ {'name' : 'sign2', 'text' : '=>', 'linehl' : 'Search',
1885 \ 'texthl' : 'Search'},
1886 \ {'name' : 'sign3', 'text' : '=>', 'linehl' : 'Search',
1887 \ 'texthl' : 'Search'},
1888 \ {'name' : 'sign4', 'text' : '=>', 'linehl' : 'Search',
1889 \ 'texthl' : 'Search'}]))
1890
1891 " Negative cases for sign_define()
1892 call assert_equal([], sign_define([]))
1893 call assert_equal([-1], sign_define([{}]))
1894 call assert_fails('call sign_define([6])', 'E715:')
1895 call assert_fails('call sign_define(["abc"])', 'E715:')
1896 call assert_fails('call sign_define([[]])', 'E715:')
1897
1898 " Place multiple signs at once with specific sign identifier
1899 let l = sign_placelist([{'id' : 1, 'group' : 'g1', 'name' : 'sign1',
1900 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 50},
1901 \ {'id' : 2, 'group' : 'g2', 'name' : 'sign2',
1902 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 100},
1903 \ {'id' : 3, 'group' : '', 'name' : 'sign3',
1904 \ 'buffer' : 'Xsign', 'lnum' : 11}])
1905 call assert_equal([1, 2, 3], l)
1906 let s = sign_getplaced('Xsign', {'group' : '*'})
1907 call assert_equal([
1908 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11,
1909 \ 'group' : 'g2', 'priority' : 100},
1910 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1911 \ 'group' : 'g1', 'priority' : 50},
1912 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11,
1913 \ 'group' : '', 'priority' : 10}], s[0].signs)
1914
1915 call sign_unplace('*')
1916
1917 " Place multiple signs at once with auto-generated sign identifier
1918 call assert_equal([1, 1, 5], sign_placelist([
1919 \ {'group' : 'g1', 'name' : 'sign1',
1920 \ 'buffer' : 'Xsign', 'lnum' : 11},
1921 \ {'group' : 'g2', 'name' : 'sign2',
1922 \ 'buffer' : 'Xsign', 'lnum' : 11},
1923 \ {'group' : '', 'name' : 'sign3',
1924 \ 'buffer' : 'Xsign', 'lnum' : 11}]))
1925 let s = sign_getplaced('Xsign', {'group' : '*'})
1926 call assert_equal([
1927 \ {'id' : 5, 'name' : 'sign3', 'lnum' : 11,
1928 \ 'group' : '', 'priority' : 10},
1929 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 11,
1930 \ 'group' : 'g2', 'priority' : 10},
1931 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1932 \ 'group' : 'g1', 'priority' : 10}], s[0].signs)
1933
1934 " Change an existing sign without specifying the group
1935 call assert_equal([5], sign_placelist([
1936 \ {'id' : 5, 'name' : 'sign1', 'buffer' : 'Xsign'}]))
1937 let s = sign_getplaced('Xsign', {'id' : 5, 'group' : ''})
1938 call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
1939 \ 'group' : '', 'priority' : 10}], s[0].signs)
1940
Bram Moolenaar42aff462019-08-21 13:20:29 +02001941 " Place a sign using '.' as the line number
1942 call cursor(23, 1)
1943 call assert_equal([7], sign_placelist([
1944 \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
1945 let s = sign_getplaced('%', {'lnum' : '.'})
1946 call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
1947 \ 'group' : '', 'priority' : 10}], s[0].signs)
1948
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001949 " Place sign without a sign name
1950 call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
1951 \ 'lnum' : 12, 'group' : ''}]))
1952
1953 " Place sign without a buffer
1954 call assert_equal([-1], sign_placelist([{'id' : 10, 'name' : 'sign1',
1955 \ 'lnum' : 12, 'group' : ''}]))
1956
1957 " Invalid arguments
1958 call assert_equal([], sign_placelist([]))
1959 call assert_fails('call sign_placelist({})', "E714:")
1960 call assert_fails('call sign_placelist([[]])', "E715:")
1961 call assert_fails('call sign_placelist(["abc"])', "E715:")
1962 call assert_fails('call sign_placelist([100])', "E715:")
1963
1964 " Unplace multiple signs
1965 call assert_equal([0, 0, 0], sign_unplacelist([{'id' : 5},
1966 \ {'id' : 1, 'group' : 'g1'}, {'id' : 1, 'group' : 'g2'}]))
1967
1968 " Invalid arguments
1969 call assert_equal([], sign_unplacelist([]))
1970 call assert_fails('call sign_unplacelist({})', "E714:")
1971 call assert_fails('call sign_unplacelist([[]])', "E715:")
1972 call assert_fails('call sign_unplacelist(["abc"])', "E715:")
1973 call assert_fails('call sign_unplacelist([100])', "E715:")
1974 call assert_fails("call sign_unplacelist([{'id' : -1}])", 'E474')
1975
1976 call assert_equal([0, 0, 0, 0],
1977 \ sign_undefine(['sign1', 'sign2', 'sign3', 'sign4']))
1978 call assert_equal([], sign_getdefined())
1979
1980 " Invalid arguments
1981 call assert_equal([], sign_undefine([]))
1982 call assert_fails('call sign_undefine([[]])', 'E730:')
1983 call assert_fails('call sign_undefine([{}])', 'E731:')
1984 call assert_fails('call sign_undefine(["1abc2"])', 'E155:')
1985
1986 call sign_unplace('*')
1987 call sign_undefine()
1988 enew!
1989 call delete("Xsign")
1990endfunc