blob: 80f7160b100a7e1e476262321f722df897c67213 [file] [log] [blame]
Bram Moolenaar09de1752016-08-08 22:26:48 +02001" Test for signs
2
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02003source check.vim
4CheckFeature signs
Bram Moolenaar09de1752016-08-08 22:26:48 +02005
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02006source screendump.vim
7
Bram Moolenaar09de1752016-08-08 22:26:48 +02008func Test_sign()
9 new
10 call setline(1, ['a', 'b', 'c', 'd'])
11
Bram Moolenaar446a9732016-08-10 21:36:23 +020012 " Define some signs.
13 " We can specify icons even if not all versions of vim support icons as
14 " icon is ignored when not supported. "(not supported)" is shown after
15 " the icon name when listing signs.
Bram Moolenaar09de1752016-08-08 22:26:48 +020016 sign define Sign1 text=x
Bram Moolenaard933c822019-08-21 13:45:16 +020017
Bram Moolenaare413ea02021-11-24 16:20:13 +000018 call Sign_command_ignore_error('sign define Sign2 text=xy texthl=Title linehl=Error culhl=Search icon=../../pixmaps/stock_vim_find_help.png')
Bram Moolenaar09de1752016-08-08 22:26:48 +020019
20 " Test listing signs.
21 let a=execute('sign list')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010022 call assert_match('^\nsign Sign1 text=x \nsign Sign2 ' .
23 \ 'icon=../../pixmaps/stock_vim_find_help.png .*text=xy ' .
Bram Moolenaare413ea02021-11-24 16:20:13 +000024 \ 'linehl=Error texthl=Title culhl=Search$', a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020025
26 let a=execute('sign list Sign1')
27 call assert_equal("\nsign Sign1 text=x ", a)
28
Bram Moolenaar7d83bf42018-12-29 18:53:55 +010029 " Split the window to the bottom to verify sign jump will stay in the
30 " current window if the buffer is displayed there.
Bram Moolenaar446a9732016-08-10 21:36:23 +020031 let bn = bufnr('%')
32 let wn = winnr()
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010033 exe 'sign place 41 line=3 name=Sign1 buffer=' . bn
Bram Moolenaar09de1752016-08-08 22:26:48 +020034 1
Bram Moolenaar446a9732016-08-10 21:36:23 +020035 bot split
36 exe 'sign jump 41 buffer=' . bufnr('%')
37 call assert_equal('c', getline('.'))
38 call assert_equal(3, winnr())
39 call assert_equal(bn, bufnr('%'))
40 call assert_notequal(wn, winnr())
41
42 " Create a new buffer and check that ":sign jump" switches to the old buffer.
43 1
44 new foo
45 call assert_notequal(bn, bufnr('%'))
46 exe 'sign jump 41 buffer=' . bn
47 call assert_equal(bn, bufnr('%'))
Bram Moolenaar09de1752016-08-08 22:26:48 +020048 call assert_equal('c', getline('.'))
49
Bram Moolenaar446a9732016-08-10 21:36:23 +020050 " Redraw to make sure that screen redraw with sign gets exercised,
51 " with and without 'rightleft'.
52 if has('rightleft')
53 set rightleft
54 redraw
55 set norightleft
56 endif
57 redraw
Bram Moolenaar09de1752016-08-08 22:26:48 +020058
Bram Moolenaar446a9732016-08-10 21:36:23 +020059 " Check that we can't change sign.
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010060 call assert_fails("sign place 40 name=Sign1 buffer=" . bufnr('%'), 'E885:')
Bram Moolenaar446a9732016-08-10 21:36:23 +020061
62 " Check placed signs
Bram Moolenaar09de1752016-08-08 22:26:48 +020063 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +010064 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010065 \ " line=3 id=41 name=Sign1 priority=10\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +020066
Bram Moolenaar446a9732016-08-10 21:36:23 +020067 " Unplace the sign and try jumping to it again should fail.
68 sign unplace 41
Bram Moolenaar09de1752016-08-08 22:26:48 +020069 1
Bram Moolenaar7a2d9892018-12-24 20:23:49 +010070 call assert_fails("sign jump 41 buffer=" . bufnr('%'), 'E157:')
Bram Moolenaar09de1752016-08-08 22:26:48 +020071 call assert_equal('a', getline('.'))
72
73 " Unplace sign on current line.
Bram Moolenaar446a9732016-08-10 21:36:23 +020074 exe 'sign place 42 line=4 name=Sign2 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020075 4
76 sign unplace
77 let a=execute('sign place')
78 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +010079
Bram Moolenaar09de1752016-08-08 22:26:48 +020080 " Try again to unplace sign on current line, it should fail this time.
81 call assert_fails('sign unplace', 'E159:')
82
83 " Unplace all signs.
Bram Moolenaar446a9732016-08-10 21:36:23 +020084 exe 'sign place 41 line=3 name=Sign1 buffer=' . bufnr('%')
Bram Moolenaar09de1752016-08-08 22:26:48 +020085 sign unplace *
86 let a=execute('sign place')
87 call assert_equal("\n--- Signs ---\n", a)
88
Bram Moolenaarb328cca2019-01-06 16:24:01 +010089 " Place a sign without specifying the filename or buffer
90 sign place 77 line=9 name=Sign2
91 let a=execute('sign place')
92 call assert_equal("\n--- Signs ---\nSigns for [NULL]:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +010093 \ " line=9 id=77 name=Sign2 priority=10\n", a)
Bram Moolenaarb328cca2019-01-06 16:24:01 +010094 sign unplace *
95
Bram Moolenaar446a9732016-08-10 21:36:23 +020096 " Check :jump with file=...
97 edit foo
98 call setline(1, ['A', 'B', 'C', 'D'])
99
Bram Moolenaard933c822019-08-21 13:45:16 +0200100 call Sign_command_ignore_error('sign define Sign3 text=y texthl=DoesNotExist linehl=DoesNotExist icon=doesnotexist.xpm')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200101
102 let fn = expand('%:p')
103 exe 'sign place 43 line=2 name=Sign3 file=' . fn
104 edit bar
105 call assert_notequal(fn, expand('%:p'))
106 exe 'sign jump 43 file=' . fn
107 call assert_equal('B', getline('.'))
108
Bram Moolenaara3556522018-12-31 22:02:29 +0100109 " Check for jumping to a sign in a hidden buffer
110 enew! | only!
111 edit foo
112 call setline(1, ['A', 'B', 'C', 'D'])
113 let fn = expand('%:p')
114 exe 'sign place 21 line=3 name=Sign3 file=' . fn
115 hide edit bar
116 exe 'sign jump 21 file=' . fn
117 call assert_equal('C', getline('.'))
118
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100119 " can't define a sign with a non-printable character as text
120 call assert_fails("sign define Sign4 text=\e linehl=Comment", 'E239:')
121 call assert_fails("sign define Sign4 text=a\e linehl=Comment", 'E239:')
122 call assert_fails("sign define Sign4 text=\ea linehl=Comment", 'E239:')
123
124 " Only 1 or 2 character text is allowed
125 call assert_fails("sign define Sign4 text=abc linehl=Comment", 'E239:')
126 call assert_fails("sign define Sign4 text= linehl=Comment", 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100127 call assert_fails("sign define Sign4 text=\\ ab linehl=Comment", 'E239:')
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100128
129 " define sign with whitespace
130 sign define Sign4 text=\ X linehl=Comment
131 sign undefine Sign4
132 sign define Sign4 linehl=Comment text=\ X
133 sign undefine Sign4
134
135 sign define Sign5 text=X\ linehl=Comment
136 sign undefine Sign5
137 sign define Sign5 linehl=Comment text=X\
138 sign undefine Sign5
139
140 " define sign with backslash
141 sign define Sign4 text=\\\\ linehl=Comment
142 sign undefine Sign4
143 sign define Sign4 text=\\ linehl=Comment
144 sign undefine Sign4
145
Bram Moolenaara3556522018-12-31 22:02:29 +0100146 " define a sign with a leading 0 in the name
147 sign unplace *
148 sign define 004 text=#> linehl=Comment
149 let a = execute('sign list 4')
150 call assert_equal("\nsign 4 text=#> linehl=Comment", a)
151 exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
152 let a = execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100153 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100154 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100155 exe 'sign unplace 20 buffer=' . bufnr('')
156 sign undefine 004
157 call assert_fails('sign list 4', 'E155:')
158
Bram Moolenaar09de1752016-08-08 22:26:48 +0200159 " After undefining the sign, we should no longer be able to place it.
160 sign undefine Sign1
161 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200162 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100163 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
164 \ bufnr('%'), 'E155:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200165endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200166
Bram Moolenaar446a9732016-08-10 21:36:23 +0200167" Undefining placed sign is not recommended.
168" Quoting :help sign
169"
170" :sign undefine {name}
171" Deletes a previously defined sign. If signs with this {name}
172" are still placed this will cause trouble.
173func Test_sign_undefine_still_placed()
174 new foobar
175 sign define Sign text=x
176 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
177 sign undefine Sign
178
179 " Listing placed sign should show that sign is deleted.
180 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100181 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100182 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200183
184 sign unplace 41
185 let a=execute('sign place')
186 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200187endfunc
188
189func Test_sign_completion()
190 sign define Sign1 text=x
191 sign define Sign2 text=y
192
193 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
194 call assert_equal('"sign define jump list place undefine unplace', @:)
195
196 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
197 call assert_equal('"sign define Sign icon= linehl= text= texthl=', @:)
198
199 call feedkeys(":sign define Sign linehl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100200 call assert_equal('"sign define Sign linehl=SpellBad SpellCap ' .
201 \ 'SpellLocal SpellRare', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200202
Bram Moolenaar3678f652019-02-17 14:50:25 +0100203 call feedkeys(":sign define Sign texthl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
204 call assert_equal('"sign define Sign texthl=SpellBad SpellCap ' .
205 \ 'SpellLocal SpellRare', @:)
206
207 call writefile(repeat(["Sun is shining"], 30), "XsignOne")
208 call writefile(repeat(["Sky is blue"], 30), "XsignTwo")
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200209 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
210 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200211
Bram Moolenaar3678f652019-02-17 14:50:25 +0100212 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200213 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
214 call assert_equal('"sign undefine Sign1 Sign2', @:)
215
216 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100217 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
218 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200219
220 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
221 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
222
Bram Moolenaar3678f652019-02-17 14:50:25 +0100223 edit XsignOne
224 sign place 1 name=Sign1 line=5
225 sign place 1 name=Sign1 group=g1 line=10
226 edit XsignTwo
227 sign place 1 name=Sign2 group=g2 line=15
228
229 " Test for completion of group= and file= arguments to ':sign place'
230 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
231 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
232 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
233 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
234
235 " Test for completion of arguments to 'sign place' without sign identifier
236 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
237 call assert_equal('"sign place buffer= file= group=', @:)
238 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
239 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
240 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
241 call assert_equal('"sign place group=g1 g2', @:)
242 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
243 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
244
245 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200246 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100247 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100248 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
249 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
250 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
251 call assert_equal('"sign unplace 1 group=g1 g2', @:)
252 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
253 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200254
Bram Moolenaar3678f652019-02-17 14:50:25 +0100255 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200256 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
257 call assert_equal('"sign list Sign1 Sign2', @:)
258
Bram Moolenaar3678f652019-02-17 14:50:25 +0100259 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200260 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100261 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100262 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
263 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
264 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
265 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200266
Bram Moolenaar3678f652019-02-17 14:50:25 +0100267 " Error cases
268 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
269 call assert_equal('"sign here', @:)
270 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
271 call assert_equal("\"sign define Sign here=\<C-A>", @:)
272 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
273 call assert_equal("\"sign place 1 here=\<C-A>", @:)
274 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
275 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
276 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
277 call assert_equal("\"sign here there\<C-A>", @:)
278 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
279 call assert_equal("\"sign here there=\<C-A>", @:)
280
281 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200282 sign undefine Sign1
283 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100284 enew
285 call delete('XsignOne')
286 call delete('XsignTwo')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200287endfunc
288
289func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100290 sign define Sign1 text=x
291
Bram Moolenaar09de1752016-08-08 22:26:48 +0200292 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200293 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200294 call assert_fails('sign xxx', 'E160:')
295 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200296 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200297 call assert_fails('sign undefine', 'E156:')
298 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200299 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100300 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
301 call assert_fails('sign place buffer=999', 'E158:')
302 call assert_fails('sign jump buffer=999', 'E158:')
303 call assert_fails('sign jump 1 file=', 'E158:')
304 call assert_fails('sign jump 1 group=', 'E474:')
305 call assert_fails('sign jump 1 name=', 'E474:')
306 call assert_fails('sign jump 1 name=Sign1', 'E474:')
307 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200308 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100309 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100310 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
311 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100312 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100313 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
314 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100315 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100316 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
317 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100318 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100319 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
320 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100321 " Sign identifier and '*' for :sign unplace
322 call assert_fails("sign unplace 2 *", 'E474:')
323 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100324 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
325 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100326 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100327 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
328 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100329 call assert_fails("sign unplace 1 xxx", 'E474:')
330 call assert_fails("sign unplace * xxx", 'E474:')
331 call assert_fails("sign unplace xxx", 'E474:')
332 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100333 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100334 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100335 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100336 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100337 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100338 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100339 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100340 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100341 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100342 " Placing a sign with only sign identifier
343 call assert_fails("sign place 2", 'E474:')
344 " Placing a sign with only a name
345 call assert_fails("sign place abc", 'E474:')
346 " Placing a sign with only line number
347 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100348 " Placing a sign with only sign group
349 call assert_fails("sign place 5 group=g1", 'E474:')
350 call assert_fails("sign place 5 group=*", 'E474:')
351 " Placing a sign with only sign priority
352 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100353
354 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200355endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200356
357func Test_sign_delete_buffer()
358 new
359 sign define Sign text=x
360 let bufnr = bufnr('%')
361 new
362 exe 'bd ' . bufnr
363 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
364 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
365 sign unplace 61
366 sign undefine Sign
367endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100368
Bram Moolenaard933c822019-08-21 13:45:16 +0200369" Ignore error: E255: Couldn't read in sign data!
370" This error can happen when running in the GUI.
371" Some gui like Motif do not support the png icon format.
372func Sign_command_ignore_error(cmd)
373 try
374 exe a:cmd
375 catch /E255:/
376 endtry
377endfunc
378
379" ignore error: E255: Couldn't read in sign data!
380" This error can happen when running in gui.
381func Sign_define_ignore_error(name, attr)
382 try
383 call sign_define(a:name, a:attr)
384 catch /E255:/
385 endtry
386endfunc
387
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100388" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100389func Test_sign_funcs()
390 " Remove all the signs
391 call sign_unplace('*')
392 call sign_undefine()
393
394 " Tests for sign_define()
Bram Moolenaare413ea02021-11-24 16:20:13 +0000395 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error',
396 \ 'culhl': 'Visual'}
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200397 call assert_equal(0, "sign1"->sign_define(attr))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100398 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000399 \ 'linehl' : 'Search', 'culhl' : 'Visual', 'text' : '=>'}],
400 \ sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100401
402 " Define a new sign without attributes and then update it
403 call sign_define("sign2")
404 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000405 \ 'culhl': 'DiffDelete', 'icon' : 'sign2.ico'}
Bram Moolenaard933c822019-08-21 13:45:16 +0200406 call Sign_define_ignore_error("sign2", attr)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100407 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000408 \ 'linehl' : 'DiffAdd', 'culhl' : 'DiffDelete', 'text' : '!!',
409 \ 'icon' : 'sign2.ico'}], "sign2"->sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100410
411 " Test for a sign name with digits
412 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
413 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
414 \ sign_getdefined(0002))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200415 eval 0002->sign_undefine()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100416
417 " Tests for invalid arguments to sign_define()
418 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
419 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200420 call assert_fails('call sign_define({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100421 call assert_fails('call sign_define("sign6", [])', 'E715:')
422
423 " Tests for sign_getdefined()
424 call assert_equal([], sign_getdefined("none"))
425 call assert_fails('call sign_getdefined({})', 'E731:')
426
427 " Tests for sign_place()
428 call writefile(repeat(["Sun is shining"], 30), "Xsign")
429 edit Xsign
430
431 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
432 \ {'lnum' : 20}))
433 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
434 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
435 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
436 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
437 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
438 \ 'priority' : 10}]}],
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200439 \ '%'->sign_getplaced({'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100440 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
441 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
442 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100443 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100444
445 " Tests for invalid arguments to sign_place()
446 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
447 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
448 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])',
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200449 \ 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100450 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
451 \ {"lnum" : 30})', 'E474:')
452 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
453 \ {"lnum" : 30})', 'E155:')
454 call assert_fails('call sign_place(10, "", "", "Xsign",
455 \ {"lnum" : 30})', 'E155:')
456 call assert_fails('call sign_place(10, "", [], "Xsign",
457 \ {"lnum" : 30})', 'E730:')
458 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
459 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100460 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100461 \ 'E158:')
462 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200463 \ 'E730:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100464 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200465 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100466 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200467 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100468 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200469 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100470 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
471
472 " Tests for sign_getplaced()
473 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
474 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
475 \ 'priority' : 10}]}],
476 \ sign_getplaced(bufnr('Xsign')))
477 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
478 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
479 \ 'priority' : 10}]}],
480 \ sign_getplaced())
481 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100482 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100483 call assert_fails('call sign_getplaced(-1)', 'E158:')
484 call assert_fails('call sign_getplaced("Xsign", [])', 'E715:')
485 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
486 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
487 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
488 \ 'E745:')
489 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
490 \ sign_getplaced('Xsign', {'id' : 44}))
491 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
492 \ 'E745:')
493
494 " Tests for sign_unplace()
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200495 eval 20->sign_place('', 'sign2', 'Xsign', {"lnum" : 30})
Bram Moolenaar162b7142018-12-21 15:17:36 +0100496 call assert_equal(0, sign_unplace('',
497 \ {'id' : 20, 'buffer' : 'Xsign'}))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200498 call assert_equal(-1, ''->sign_unplace(
Bram Moolenaar162b7142018-12-21 15:17:36 +0100499 \ {'id' : 30, 'buffer' : 'Xsign'}))
500 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
501 call assert_fails("call sign_unplace('',
502 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
503 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100504 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100505 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100506 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100507 call assert_fails("call sign_unplace('g1', 'mySign')", 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100508
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200509 call sign_unplace('*')
510
511 " Test for modifying a placed sign
512 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
513 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
514 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
515 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
516 \ 'priority' : 10}]}],
517 \ sign_getplaced())
518
Bram Moolenaar162b7142018-12-21 15:17:36 +0100519 " Tests for sign_undefine()
520 call assert_equal(0, sign_undefine("sign1"))
521 call assert_equal([], sign_getdefined("sign1"))
522 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200523 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100524
Bram Moolenaar42aff462019-08-21 13:20:29 +0200525 " Test for using '.' as the line number for sign_place()
Bram Moolenaard933c822019-08-21 13:45:16 +0200526 call Sign_define_ignore_error("sign1", attr)
Bram Moolenaar42aff462019-08-21 13:20:29 +0200527 call cursor(22, 1)
528 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
529 \ {'lnum' : '.'}))
530 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
531 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
532 \ 'priority' : 10}]}],
533 \ sign_getplaced('%', {'lnum' : 22}))
534
Bram Moolenaar162b7142018-12-21 15:17:36 +0100535 call delete("Xsign")
536 call sign_unplace('*')
537 call sign_undefine()
538 enew | only
539endfunc
540
541" Tests for sign groups
542func Test_sign_group()
543 enew | only
544 " Remove all the signs
545 call sign_unplace('*')
546 call sign_undefine()
547
548 call writefile(repeat(["Sun is shining"], 30), "Xsign")
549
550 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
551 call assert_equal(0, sign_define("sign1", attr))
552
553 edit Xsign
554 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100555
556 " Error case
557 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
558 \ {'lnum' : 30})", 'E730:')
559
560 " place three signs with the same identifier. One in the global group and
561 " others in the named groups
562 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
563 \ {'lnum' : 10}))
564 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
565 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
566
567 " Test for sign_getplaced() with group
568 let s = sign_getplaced('Xsign')
569 call assert_equal(1, len(s[0].signs))
570 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100571 let s = sign_getplaced(bnum, {'group' : ''})
572 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
573 \ 'priority' : 10}], s[0].signs)
574 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100575 let s = sign_getplaced(bnum, {'group' : 'g2'})
576 call assert_equal('g2', s[0].signs[0].group)
577 let s = sign_getplaced(bnum, {'group' : 'g3'})
578 call assert_equal([], s[0].signs)
579 let s = sign_getplaced(bnum, {'group' : '*'})
580 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
581 \ 'priority' : 10},
582 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
583 \ 'priority' : 10},
584 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
585 \ 'priority' : 10}],
586 \ s[0].signs)
587
588 " Test for sign_getplaced() with id
589 let s = sign_getplaced(bnum, {'id' : 5})
590 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
591 \ 'priority' : 10}],
592 \ s[0].signs)
593 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
594 call assert_equal(
595 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
596 \ 'priority' : 10}],
597 \ s[0].signs)
598 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
599 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
600 \ 'priority' : 10},
601 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
602 \ 'priority' : 10},
603 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
604 \ 'priority' : 10}],
605 \ s[0].signs)
606 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
607 call assert_equal([], s[0].signs)
608
609 " Test for sign_getplaced() with lnum
610 let s = sign_getplaced(bnum, {'lnum' : 20})
611 call assert_equal([], s[0].signs)
612 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
613 call assert_equal(
614 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
615 \ 'priority' : 10}],
616 \ s[0].signs)
617 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
618 call assert_equal(
619 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
620 \ 'priority' : 10}],
621 \ s[0].signs)
622 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
623 call assert_equal([], s[0].signs)
624
625 " Error case
626 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
627 \ 'E730:')
628
629 " Clear the sign in global group
630 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
631 let s = sign_getplaced(bnum, {'group' : '*'})
632 call assert_equal([
633 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
634 \ 'priority' : 10},
635 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
636 \ 'priority' : 10}],
637 \ s[0].signs)
638
639 " Clear the sign in one of the groups
640 call sign_unplace('g1', {'buffer' : 'Xsign'})
641 let s = sign_getplaced(bnum, {'group' : '*'})
642 call assert_equal([
643 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
644 \ 'priority' : 10}],
645 \ s[0].signs)
646
647 " Clear all the signs from the buffer
648 call sign_unplace('*', {'buffer' : bnum})
649 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
650
651 " Clear sign across groups using an identifier
652 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
653 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
654 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
655 call assert_equal(0, sign_unplace('*', {'id' : 25}))
656 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
657
658 " Error case
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200659 call assert_fails("call sign_unplace({})", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100660
661 " Place a sign in the global group and try to delete it using a group
662 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
663 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
664
665 " Place signs in multiple groups and delete all the signs in one of the
666 " group
667 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
668 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
669 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
670 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
671 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
672 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
673 call assert_equal(0, sign_unplace('g1'))
674 let s = sign_getplaced(bnum, {'group' : 'g1'})
675 call assert_equal([], s[0].signs)
676 let s = sign_getplaced(bnum)
677 call assert_equal(2, len(s[0].signs))
678 let s = sign_getplaced(bnum, {'group' : 'g2'})
679 call assert_equal('g2', s[0].signs[0].group)
680 call assert_equal(0, sign_unplace('', {'id' : 5}))
681 call assert_equal(0, sign_unplace('', {'id' : 6}))
682 let s = sign_getplaced(bnum, {'group' : 'g2'})
683 call assert_equal('g2', s[0].signs[0].group)
684 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
685
686 call sign_unplace('*')
687
688 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100689 sign place 5 line=10 name=sign1 file=Xsign
690 sign place 5 group=g1 line=10 name=sign1 file=Xsign
691 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100692
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100693 " Tests for the ':sign place' command
694
695 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100696 let a = execute('sign place 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 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={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100701 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +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", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100704
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100705 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100706 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100707 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100708 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
709 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
710 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100711
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100712 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100713 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100714 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
715
716 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100717 let bnum = bufnr('Xsign')
718 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
719 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
720 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
721
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100722 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100723 let a = execute('sign place 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=10 id=5 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={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100728 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100729 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100730 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100731
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100732 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100733 let a = execute('sign place group=* buffer=' . bnum)
734 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100735 \ " line=10 id=5 name=sign1 priority=10\n" .
736 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
737 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100738
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100739 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100740 let a = execute('sign place group=xyz buffer=' . bnum)
741 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
742
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100743 " :sign place
744 let a = execute('sign place')
745 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100746 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100747
Bram Moolenaarb589f952019-01-07 22:10:00 +0100748 " Place signs in more than one buffer and list the signs
749 split foo
750 set buftype=nofile
751 sign place 25 line=76 name=sign1 priority=99 file=foo
752 let a = execute('sign place')
753 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
754 \ " line=10 id=5 name=sign1 priority=10\n" .
755 \ "Signs for foo:\n" .
756 \ " line=76 id=25 name=sign1 priority=99\n", a)
757 close
758 bwipe foo
759
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100760 " :sign place group={group}
761 let a = execute('sign place group=g1')
762 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100763 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100764
765 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100766 let a = execute('sign place group=*')
767 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100768 \ " line=10 id=5 name=sign1 priority=10\n" .
769 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
770 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100771
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100772 " Test for ':sign jump' command with groups
773 sign jump 5 group=g1 file=Xsign
774 call assert_equal(11, line('.'))
775 call assert_equal('Xsign', bufname(''))
776 sign jump 5 group=g2 file=Xsign
777 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100778
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100779 " Test for :sign jump command without the filename or buffer
780 sign jump 5
781 call assert_equal(10, line('.'))
782 sign jump 5 group=g1
783 call assert_equal(11, line('.'))
784
Bram Moolenaar162b7142018-12-21 15:17:36 +0100785 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100786 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100787
788 call delete("Xsign")
789 call sign_unplace('*')
790 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100791 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100792endfunc
793
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100794" Place signs used for ":sign unplace" command test
795func Place_signs_for_test()
796 call sign_unplace('*')
797
798 sign place 3 line=10 name=sign1 file=Xsign1
799 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
800 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
801 sign place 4 line=15 name=sign1 file=Xsign1
802 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
803 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
804 sign place 5 line=20 name=sign1 file=Xsign2
805 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
806 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
807 sign place 6 line=25 name=sign1 file=Xsign2
808 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
809 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
810endfunc
811
812" Place multiple signs in a single line for test
813func Place_signs_at_line_for_test()
814 call sign_unplace('*')
815 sign place 3 line=13 name=sign1 file=Xsign1
816 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
817 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
818 sign place 4 line=13 name=sign1 file=Xsign1
819 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
820 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
821endfunc
822
823" Tests for the ':sign unplace' command
824func Test_sign_unplace()
825 enew | only
826 " Remove all the signs
827 call sign_unplace('*')
828 call sign_undefine()
829
830 " Create two files and define signs
831 call writefile(repeat(["Sun is shining"], 30), "Xsign1")
832 call writefile(repeat(["It is beautiful"], 30), "Xsign2")
833
834 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
835 call sign_define("sign1", attr)
836
837 edit Xsign1
838 let bnum1 = bufnr('%')
839 split Xsign2
840 let bnum2 = bufnr('%')
841
842 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
843 \ 'priority' : 10},
844 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
845 \ 'priority' : 10},
846 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
847 \ 'priority' : 10},
848 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
849 \ 'priority' : 10},
850 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
851 \ 'priority' : 10},
852 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
853 \ 'priority' : 10},]
854 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
855 \ 'priority' : 10},
856 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
857 \ 'priority' : 10},
858 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
859 \ 'priority' : 10},
860 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
861 \ 'priority' : 10},
862 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
863 \ 'priority' : 10},
864 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
865 \ 'priority' : 10},]
866
867 " Test for :sign unplace {id} file={fname}
868 call Place_signs_for_test()
869 sign unplace 3 file=Xsign1
870 sign unplace 6 file=Xsign2
871 call assert_equal(
872 \ filter(copy(signs1),
873 \ {idx, val -> val.id != 3 || val.group != ''}),
874 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
875 call assert_equal(
876 \ filter(copy(signs2),
877 \ {idx, val -> val.id != 6 || val.group != ''}),
878 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
879
880 " Test for :sign unplace {id} group={group} file={fname}
881 call Place_signs_for_test()
882 sign unplace 4 group=g1 file=Xsign1
883 sign unplace 5 group=g2 file=Xsign2
884 call assert_equal(
885 \ filter(copy(signs1),
886 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
887 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
888 call assert_equal(
889 \ filter(copy(signs2),
890 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
891 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
892
893 " Test for :sign unplace {id} group=* file={fname}
894 call Place_signs_for_test()
895 sign unplace 3 group=* file=Xsign1
896 sign unplace 6 group=* file=Xsign2
897 call assert_equal(
898 \ filter(copy(signs1),
899 \ {idx, val -> val.id != 3}),
900 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
901 call assert_equal(
902 \ filter(copy(signs2),
903 \ {idx, val -> val.id != 6}),
904 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
905
906 " Test for :sign unplace * file={fname}
907 call Place_signs_for_test()
908 sign unplace * file=Xsign1
909 call assert_equal(
910 \ filter(copy(signs1),
911 \ {idx, val -> val.group != ''}),
912 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
913 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
914
915 " Test for :sign unplace * group={group} file={fname}
916 call Place_signs_for_test()
917 sign unplace * group=g1 file=Xsign1
918 sign unplace * group=g2 file=Xsign2
919 call assert_equal(
920 \ filter(copy(signs1),
921 \ {idx, val -> val.group != 'g1'}),
922 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
923 call assert_equal(
924 \ filter(copy(signs2),
925 \ {idx, val -> val.group != 'g2'}),
926 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
927
928 " Test for :sign unplace * group=* file={fname}
929 call Place_signs_for_test()
930 sign unplace * group=* file=Xsign2
931 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
932 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
933
934 " Test for :sign unplace {id} buffer={nr}
935 call Place_signs_for_test()
936 exe 'sign unplace 3 buffer=' . bnum1
937 exe 'sign unplace 6 buffer=' . bnum2
938 call assert_equal(
939 \ filter(copy(signs1),
940 \ {idx, val -> val.id != 3 || val.group != ''}),
941 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
942 call assert_equal(
943 \ filter(copy(signs2),
944 \ {idx, val -> val.id != 6 || val.group != ''}),
945 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
946
947 " Test for :sign unplace {id} group={group} buffer={nr}
948 call Place_signs_for_test()
949 exe 'sign unplace 4 group=g1 buffer=' . bnum1
950 exe 'sign unplace 5 group=g2 buffer=' . bnum2
951 call assert_equal(
952 \ filter(copy(signs1),
953 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
954 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
955 call assert_equal(
956 \ filter(copy(signs2),
957 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
958 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
959
960 " Test for :sign unplace {id} group=* buffer={nr}
961 call Place_signs_for_test()
962 exe 'sign unplace 3 group=* buffer=' . bnum1
963 exe 'sign unplace 6 group=* buffer=' . bnum2
964 call assert_equal(
965 \ filter(copy(signs1),
966 \ {idx, val -> val.id != 3}),
967 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
968 call assert_equal(
969 \ filter(copy(signs2),
970 \ {idx, val -> val.id != 6}),
971 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
972
973 " Test for :sign unplace * buffer={nr}
974 call Place_signs_for_test()
975 exe 'sign unplace * buffer=' . bnum1
976 call assert_equal(
977 \ filter(copy(signs1),
978 \ {idx, val -> val.group != ''}),
979 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
980 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
981
982 " Test for :sign unplace * group={group} buffer={nr}
983 call Place_signs_for_test()
984 exe 'sign unplace * group=g1 buffer=' . bnum1
985 exe 'sign unplace * group=g2 buffer=' . bnum2
986 call assert_equal(
987 \ filter(copy(signs1),
988 \ {idx, val -> val.group != 'g1'}),
989 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
990 call assert_equal(
991 \ filter(copy(signs2),
992 \ {idx, val -> val.group != 'g2'}),
993 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
994
995 " Test for :sign unplace * group=* buffer={nr}
996 call Place_signs_for_test()
997 exe 'sign unplace * group=* buffer=' . bnum2
998 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
999 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1000
1001 " Test for :sign unplace {id}
1002 call Place_signs_for_test()
1003 sign unplace 4
1004 sign unplace 6
1005 call assert_equal(
1006 \ filter(copy(signs1),
1007 \ {idx, val -> val.id != 4 || val.group != ''}),
1008 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1009 call assert_equal(
1010 \ filter(copy(signs2),
1011 \ {idx, val -> val.id != 6 || val.group != ''}),
1012 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1013
1014 " Test for :sign unplace {id} group={group}
1015 call Place_signs_for_test()
1016 sign unplace 4 group=g1
1017 sign unplace 6 group=g2
1018 call assert_equal(
1019 \ filter(copy(signs1),
1020 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1021 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1022 call assert_equal(
1023 \ filter(copy(signs2),
1024 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1025 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1026
1027 " Test for :sign unplace {id} group=*
1028 call Place_signs_for_test()
1029 sign unplace 3 group=*
1030 sign unplace 5 group=*
1031 call assert_equal(
1032 \ filter(copy(signs1),
1033 \ {idx, val -> val.id != 3}),
1034 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1035 call assert_equal(
1036 \ filter(copy(signs2),
1037 \ {idx, val -> val.id != 5}),
1038 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1039
1040 " Test for :sign unplace *
1041 call Place_signs_for_test()
1042 sign unplace *
1043 call assert_equal(
1044 \ filter(copy(signs1),
1045 \ {idx, val -> val.group != ''}),
1046 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1047 call assert_equal(
1048 \ filter(copy(signs2),
1049 \ {idx, val -> val.group != ''}),
1050 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1051
1052 " Test for :sign unplace * group={group}
1053 call Place_signs_for_test()
1054 sign unplace * group=g1
1055 call assert_equal(
1056 \ filter(copy(signs1),
1057 \ {idx, val -> val.group != 'g1'}),
1058 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1059 call assert_equal(
1060 \ filter(copy(signs2),
1061 \ {idx, val -> val.group != 'g1'}),
1062 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1063
1064 " Test for :sign unplace * group=*
1065 call Place_signs_for_test()
1066 sign unplace * group=*
1067 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1068 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1069
1070 " Negative test cases
1071 call Place_signs_for_test()
1072 sign unplace 3 group=xy file=Xsign1
1073 sign unplace * group=xy file=Xsign1
1074 silent! sign unplace * group=* file=FileNotPresent
1075 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1076 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1077
1078 " Tests for removing sign at the current cursor position
1079
1080 " Test for ':sign unplace'
1081 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1082 \ 'priority' : 10},
1083 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1084 \ 'priority' : 10},
1085 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1086 \ 'priority' : 10},
1087 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1088 \ 'priority' : 10},
1089 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1090 \ 'priority' : 10},
1091 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1092 \ 'priority' : 10},]
1093 exe bufwinnr('Xsign1') . 'wincmd w'
1094 call cursor(13, 1)
1095
1096 " Should remove only one sign in the global group
1097 call Place_signs_at_line_for_test()
1098 sign unplace
1099 call assert_equal(
1100 \ filter(copy(signs1),
1101 \ {idx, val -> val.id != 4 || val.group != ''}),
1102 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1103 " Should remove the second sign in the global group
1104 sign unplace
1105 call assert_equal(
1106 \ filter(copy(signs1),
1107 \ {idx, val -> val.group != ''}),
1108 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1109
1110 " Test for ':sign unplace group={group}'
1111 call Place_signs_at_line_for_test()
1112 " Should remove only one sign in group g1
1113 sign unplace group=g1
1114 call assert_equal(
1115 \ filter(copy(signs1),
1116 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1117 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1118 sign unplace group=g2
1119 call assert_equal(
1120 \ filter(copy(signs1),
1121 \ {idx, val -> val.id != 4 || val.group == ''}),
1122 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1123
1124 " Test for ':sign unplace group=*'
1125 call Place_signs_at_line_for_test()
1126 sign unplace group=*
1127 sign unplace group=*
1128 sign unplace group=*
1129 call assert_equal(
1130 \ filter(copy(signs1),
1131 \ {idx, val -> val.id != 4}),
1132 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1133 sign unplace group=*
1134 sign unplace group=*
1135 sign unplace group=*
1136 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1137
1138 call sign_unplace('*')
1139 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001140 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001141 call delete("Xsign1")
1142 call delete("Xsign2")
1143endfunc
1144
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001145" Tests for auto-generating the sign identifier.
1146func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001147 enew | only
1148 call sign_unplace('*')
1149 call sign_undefine()
1150
1151 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1152 call assert_equal(0, sign_define("sign1", attr))
1153
1154 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1155 edit Xsign
1156
1157 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1158 \ {'lnum' : 10}))
1159 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1160 \ {'lnum' : 12}))
1161 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1162 \ {'lnum' : 14}))
1163 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001164 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001165 \ {'lnum' : 12}))
1166
1167 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1168 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001169 " Check for the next generated sign id in this group
1170 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1171 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001172 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1173 call assert_equal(10,
1174 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1175
1176 call delete("Xsign")
1177 call sign_unplace('*')
1178 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001179 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001180endfunc
1181
1182" Test for sign priority
1183func Test_sign_priority()
1184 enew | only
1185 call sign_unplace('*')
1186 call sign_undefine()
1187
1188 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1189 call sign_define("sign1", attr)
1190 call sign_define("sign2", attr)
1191 call sign_define("sign3", attr)
1192
1193 " Place three signs with different priority in the same line
1194 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1195 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001196
1197 call sign_place(1, 'g1', 'sign1', 'Xsign',
1198 \ {'lnum' : 11, 'priority' : 50})
1199 call sign_place(2, 'g2', 'sign2', 'Xsign',
1200 \ {'lnum' : 11, 'priority' : 100})
1201 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1202 let s = sign_getplaced('Xsign', {'group' : '*'})
1203 call assert_equal([
1204 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1205 \ 'priority' : 100},
1206 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1207 \ 'priority' : 50},
1208 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1209 \ 'priority' : 10}],
1210 \ s[0].signs)
1211
Bram Moolenaar64416122019-06-07 21:37:13 +02001212 call sign_unplace('*')
1213
1214 " Three signs on different lines with changing priorities
1215 call sign_place(1, '', 'sign1', 'Xsign',
1216 \ {'lnum' : 11, 'priority' : 50})
1217 call sign_place(2, '', 'sign2', 'Xsign',
1218 \ {'lnum' : 12, 'priority' : 60})
1219 call sign_place(3, '', 'sign3', 'Xsign',
1220 \ {'lnum' : 13, 'priority' : 70})
1221 call sign_place(2, '', 'sign2', 'Xsign',
1222 \ {'lnum' : 12, 'priority' : 40})
1223 call sign_place(3, '', 'sign3', 'Xsign',
1224 \ {'lnum' : 13, 'priority' : 30})
1225 call sign_place(1, '', 'sign1', 'Xsign',
1226 \ {'lnum' : 11, 'priority' : 50})
1227 let s = sign_getplaced('Xsign', {'group' : '*'})
1228 call assert_equal([
1229 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1230 \ 'priority' : 50},
1231 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1232 \ 'priority' : 40},
1233 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1234 \ 'priority' : 30}],
1235 \ s[0].signs)
1236
1237 call sign_unplace('*')
1238
1239 " Two signs on the same line with changing priorities
1240 call sign_place(1, '', 'sign1', 'Xsign',
1241 \ {'lnum' : 4, 'priority' : 20})
1242 call sign_place(2, '', 'sign2', 'Xsign',
1243 \ {'lnum' : 4, 'priority' : 30})
1244 let s = sign_getplaced('Xsign', {'group' : '*'})
1245 call assert_equal([
1246 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1247 \ 'priority' : 30},
1248 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1249 \ 'priority' : 20}],
1250 \ s[0].signs)
1251 " Change the priority of the last sign to highest
1252 call sign_place(1, '', 'sign1', 'Xsign',
1253 \ {'lnum' : 4, 'priority' : 40})
1254 let s = sign_getplaced('Xsign', {'group' : '*'})
1255 call assert_equal([
1256 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1257 \ 'priority' : 40},
1258 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1259 \ 'priority' : 30}],
1260 \ s[0].signs)
1261 " Change the priority of the first sign to lowest
1262 call sign_place(1, '', 'sign1', 'Xsign',
1263 \ {'lnum' : 4, 'priority' : 25})
1264 let s = sign_getplaced('Xsign', {'group' : '*'})
1265 call assert_equal([
1266 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1267 \ 'priority' : 30},
1268 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1269 \ 'priority' : 25}],
1270 \ s[0].signs)
1271 call sign_place(1, '', 'sign1', 'Xsign',
1272 \ {'lnum' : 4, 'priority' : 45})
1273 call sign_place(2, '', 'sign2', 'Xsign',
1274 \ {'lnum' : 4, 'priority' : 55})
1275 let s = sign_getplaced('Xsign', {'group' : '*'})
1276 call assert_equal([
1277 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1278 \ 'priority' : 55},
1279 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1280 \ 'priority' : 45}],
1281 \ s[0].signs)
1282
1283 call sign_unplace('*')
1284
1285 " Three signs on the same line with changing priorities
1286 call sign_place(1, '', 'sign1', 'Xsign',
1287 \ {'lnum' : 4, 'priority' : 40})
1288 call sign_place(2, '', 'sign2', 'Xsign',
1289 \ {'lnum' : 4, 'priority' : 30})
1290 call sign_place(3, '', 'sign3', 'Xsign',
1291 \ {'lnum' : 4, 'priority' : 20})
1292 let s = sign_getplaced('Xsign', {'group' : '*'})
1293 call assert_equal([
1294 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1295 \ 'priority' : 40},
1296 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1297 \ 'priority' : 30},
1298 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1299 \ 'priority' : 20}],
1300 \ s[0].signs)
1301
1302 " Change the priority of the middle sign to the highest
1303 call sign_place(2, '', 'sign2', 'Xsign',
1304 \ {'lnum' : 4, 'priority' : 50})
1305 let s = sign_getplaced('Xsign', {'group' : '*'})
1306 call assert_equal([
1307 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1308 \ 'priority' : 50},
1309 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1310 \ 'priority' : 40},
1311 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1312 \ 'priority' : 20}],
1313 \ s[0].signs)
1314
1315 " Change the priority of the middle sign to the lowest
1316 call sign_place(1, '', 'sign1', 'Xsign',
1317 \ {'lnum' : 4, 'priority' : 15})
1318 let s = sign_getplaced('Xsign', {'group' : '*'})
1319 call assert_equal([
1320 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1321 \ 'priority' : 50},
1322 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1323 \ 'priority' : 20},
1324 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1325 \ 'priority' : 15}],
1326 \ s[0].signs)
1327
1328 " Change the priority of the last sign to the highest
1329 call sign_place(1, '', 'sign1', 'Xsign',
1330 \ {'lnum' : 4, 'priority' : 55})
1331 let s = sign_getplaced('Xsign', {'group' : '*'})
1332 call assert_equal([
1333 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1334 \ 'priority' : 55},
1335 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1336 \ 'priority' : 50},
1337 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1338 \ 'priority' : 20}],
1339 \ s[0].signs)
1340
1341 " Change the priority of the first sign to the lowest
1342 call sign_place(1, '', 'sign1', 'Xsign',
1343 \ {'lnum' : 4, 'priority' : 15})
1344 let s = sign_getplaced('Xsign', {'group' : '*'})
1345 call assert_equal([
1346 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1347 \ 'priority' : 50},
1348 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1349 \ 'priority' : 20},
1350 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1351 \ 'priority' : 15}],
1352 \ s[0].signs)
1353
1354 call sign_unplace('*')
1355
1356 " Three signs on the same line with changing priorities along with other
1357 " signs
1358 call sign_place(1, '', 'sign1', 'Xsign',
1359 \ {'lnum' : 2, 'priority' : 10})
1360 call sign_place(2, '', 'sign1', 'Xsign',
1361 \ {'lnum' : 4, 'priority' : 30})
1362 call sign_place(3, '', 'sign2', 'Xsign',
1363 \ {'lnum' : 4, 'priority' : 20})
1364 call sign_place(4, '', 'sign3', 'Xsign',
1365 \ {'lnum' : 4, 'priority' : 25})
1366 call sign_place(5, '', 'sign2', 'Xsign',
1367 \ {'lnum' : 6, 'priority' : 80})
1368 let s = sign_getplaced('Xsign', {'group' : '*'})
1369 call assert_equal([
1370 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1371 \ 'priority' : 10},
1372 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1373 \ 'priority' : 30},
1374 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1375 \ 'priority' : 25},
1376 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1377 \ 'priority' : 20},
1378 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1379 \ 'priority' : 80}],
1380 \ s[0].signs)
1381
1382 " Change the priority of the first sign to lowest
1383 call sign_place(2, '', 'sign1', 'Xsign',
1384 \ {'lnum' : 4, 'priority' : 15})
1385 let s = sign_getplaced('Xsign', {'group' : '*'})
1386 call assert_equal([
1387 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1388 \ 'priority' : 10},
1389 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1390 \ 'priority' : 25},
1391 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1392 \ 'priority' : 20},
1393 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1394 \ 'priority' : 15},
1395 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1396 \ 'priority' : 80}],
1397 \ s[0].signs)
1398
1399 " Change the priority of the last sign to highest
1400 call sign_place(2, '', 'sign1', 'Xsign',
1401 \ {'lnum' : 4, 'priority' : 30})
1402 let s = sign_getplaced('Xsign', {'group' : '*'})
1403 call assert_equal([
1404 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1405 \ 'priority' : 10},
1406 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1407 \ 'priority' : 30},
1408 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1409 \ 'priority' : 25},
1410 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1411 \ 'priority' : 20},
1412 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1413 \ 'priority' : 80}],
1414 \ s[0].signs)
1415
1416 " Change the priority of the middle sign to lowest
1417 call sign_place(4, '', 'sign3', 'Xsign',
1418 \ {'lnum' : 4, 'priority' : 15})
1419 let s = sign_getplaced('Xsign', {'group' : '*'})
1420 call assert_equal([
1421 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1422 \ 'priority' : 10},
1423 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1424 \ 'priority' : 30},
1425 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1426 \ 'priority' : 20},
1427 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1428 \ 'priority' : 15},
1429 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1430 \ 'priority' : 80}],
1431 \ s[0].signs)
1432
1433 " Change the priority of the middle sign to highest
1434 call sign_place(3, '', 'sign2', 'Xsign',
1435 \ {'lnum' : 4, 'priority' : 35})
1436 let s = sign_getplaced('Xsign', {'group' : '*'})
1437 call assert_equal([
1438 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1439 \ 'priority' : 10},
1440 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1441 \ 'priority' : 35},
1442 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1443 \ 'priority' : 30},
1444 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1445 \ 'priority' : 15},
1446 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1447 \ 'priority' : 80}],
1448 \ s[0].signs)
1449
1450 call sign_unplace('*')
1451
1452 " Multiple signs with the same priority on the same line
1453 call sign_place(1, '', 'sign1', 'Xsign',
1454 \ {'lnum' : 4, 'priority' : 20})
1455 call sign_place(2, '', 'sign2', 'Xsign',
1456 \ {'lnum' : 4, 'priority' : 20})
1457 call sign_place(3, '', 'sign3', 'Xsign',
1458 \ {'lnum' : 4, 'priority' : 20})
1459 let s = sign_getplaced('Xsign', {'group' : '*'})
1460 call assert_equal([
1461 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1462 \ 'priority' : 20},
1463 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1464 \ 'priority' : 20},
1465 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1466 \ 'priority' : 20}],
1467 \ s[0].signs)
1468 " Place the last sign again with the same priority
1469 call sign_place(1, '', 'sign1', 'Xsign',
1470 \ {'lnum' : 4, 'priority' : 20})
1471 let s = sign_getplaced('Xsign', {'group' : '*'})
1472 call assert_equal([
1473 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1474 \ 'priority' : 20},
1475 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1476 \ 'priority' : 20},
1477 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1478 \ 'priority' : 20}],
1479 \ s[0].signs)
1480 " Place the first sign again with the same priority
1481 call sign_place(1, '', 'sign1', 'Xsign',
1482 \ {'lnum' : 4, 'priority' : 20})
1483 let s = sign_getplaced('Xsign', {'group' : '*'})
1484 call assert_equal([
1485 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1486 \ 'priority' : 20},
1487 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1488 \ 'priority' : 20},
1489 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1490 \ 'priority' : 20}],
1491 \ s[0].signs)
1492 " Place the middle sign again with the same priority
1493 call sign_place(3, '', 'sign3', 'Xsign',
1494 \ {'lnum' : 4, 'priority' : 20})
1495 let s = sign_getplaced('Xsign', {'group' : '*'})
1496 call assert_equal([
1497 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1498 \ 'priority' : 20},
1499 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1500 \ 'priority' : 20},
1501 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1502 \ 'priority' : 20}],
1503 \ s[0].signs)
1504
1505 call sign_unplace('*')
1506
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001507 " Place multiple signs with same id on a line with different priority
1508 call sign_place(1, '', 'sign1', 'Xsign',
1509 \ {'lnum' : 5, 'priority' : 20})
1510 call sign_place(1, '', 'sign2', 'Xsign',
1511 \ {'lnum' : 5, 'priority' : 10})
1512 let s = sign_getplaced('Xsign', {'lnum' : 5})
1513 call assert_equal([
1514 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1515 \ 'priority' : 10}],
1516 \ s[0].signs)
1517 call sign_place(1, '', 'sign2', 'Xsign',
1518 \ {'lnum' : 5, 'priority' : 5})
1519 let s = sign_getplaced('Xsign', {'lnum' : 5})
1520 call assert_equal([
1521 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1522 \ 'priority' : 5}],
1523 \ s[0].signs)
1524
Bram Moolenaar162b7142018-12-21 15:17:36 +01001525 " Error case
1526 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1527 \ [])", 'E715:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001528 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1529 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001530 call sign_unplace('*')
1531
1532 " Tests for the :sign place command with priority
1533 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1534 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1535 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1536 let a = execute('sign place group=*')
1537 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001538 \ " line=10 id=5 name=sign1 priority=30\n" .
1539 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1540 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001541
1542 " Test for :sign place group={group}
1543 let a = execute('sign place group=g1')
1544 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001545 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001546
1547 call sign_unplace('*')
1548 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001549 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001550 call delete("Xsign")
1551endfunc
1552
1553" Tests for memory allocation failures in sign functions
1554func Test_sign_memfailures()
1555 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1556 edit Xsign
1557
1558 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1559 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1560 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1561 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1562 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1563 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1564 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1565
1566 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1567 call sign_define("sign1", attr)
1568 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1569 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1570
1571 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1572 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1573 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1574 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1575 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1576
1577 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1578 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1579 \ 'E342:')
1580
1581 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1582 call assert_fails('call getbufinfo()', 'E342:')
1583 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1584 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1585 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1586 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1587 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1588
1589 call sign_unplace('*')
1590 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001591 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001592 call delete("Xsign")
1593endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001594
1595" Test for auto-adjusting the line number of a placed sign.
1596func Test_sign_lnum_adjust()
1597 enew! | only!
1598
1599 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001600 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001601 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1602 let l = sign_getplaced(bufnr(''))
1603 call assert_equal(3, l[0].signs[0].lnum)
1604
1605 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001606 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001607 let l = sign_getplaced(bufnr(''))
1608 call assert_equal(6, l[0].signs[0].lnum)
1609
1610 " Delete some lines before the sign and check the sign line number
1611 call deletebufline('%', 1, 2)
1612 let l = sign_getplaced(bufnr(''))
1613 call assert_equal(4, l[0].signs[0].lnum)
1614
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001615 " Insert some lines after the sign and check the sign line number
1616 call append(5, ['DA', 'DB'])
1617 let l = sign_getplaced(bufnr(''))
1618 call assert_equal(4, l[0].signs[0].lnum)
1619
1620 " Delete some lines after the sign and check the sign line number
1621 call deletebufline('', 6, 7)
1622 let l = sign_getplaced(bufnr(''))
1623 call assert_equal(4, l[0].signs[0].lnum)
1624
1625 " Break the undo. Otherwise the undo operation below will undo all the
1626 " changes made by this function.
1627 let &undolevels=&undolevels
1628
1629 " Delete the line with the sign
1630 call deletebufline('', 4)
1631 let l = sign_getplaced(bufnr(''))
1632 call assert_equal(4, l[0].signs[0].lnum)
1633
1634 " Undo the delete operation
1635 undo
1636 let l = sign_getplaced(bufnr(''))
1637 call assert_equal(5, l[0].signs[0].lnum)
1638
1639 " Break the undo
1640 let &undolevels=&undolevels
1641
1642 " Delete few lines at the end of the buffer including the line with the sign
1643 " Sign line number should not change (as it is placed outside of the buffer)
1644 call deletebufline('', 3, 6)
1645 let l = sign_getplaced(bufnr(''))
1646 call assert_equal(5, l[0].signs[0].lnum)
1647
1648 " Undo the delete operation. Sign should be restored to the previous line
1649 undo
1650 let l = sign_getplaced(bufnr(''))
1651 call assert_equal(5, l[0].signs[0].lnum)
1652
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001653 sign unplace * group=*
1654 sign undefine sign1
1655 enew!
1656endfunc
1657
1658" Test for changing the type of a placed sign
1659func Test_sign_change_type()
1660 enew! | only!
1661
1662 sign define sign1 text=#> linehl=Comment
1663 sign define sign2 text=@@ linehl=Comment
1664
1665 call setline(1, ['A', 'B', 'C', 'D'])
1666 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1667 let l = sign_getplaced(bufnr(''))
1668 call assert_equal('sign1', l[0].signs[0].name)
1669 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1670 let l = sign_getplaced(bufnr(''))
1671 call assert_equal('sign2', l[0].signs[0].name)
1672 call sign_place(4, '', 'sign1', '')
1673 let l = sign_getplaced(bufnr(''))
1674 call assert_equal('sign1', l[0].signs[0].name)
1675
1676 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1677 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1678 call assert_equal('sign1', l[0].signs[0].name)
1679 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1680 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1681 call assert_equal('sign2', l[0].signs[0].name)
1682 call sign_place(4, 'g1', 'sign1', '')
1683 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1684 call assert_equal('sign1', l[0].signs[0].name)
1685
1686 sign unplace * group=*
1687 sign undefine sign1
1688 sign undefine sign2
1689 enew!
1690endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001691
1692" Test for the sign_jump() function
1693func Test_sign_jump_func()
1694 enew! | only!
1695
1696 sign define sign1 text=#> linehl=Comment
1697
1698 edit foo
1699 set buftype=nofile
1700 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1701 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1702 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1703 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1704 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1705 split bar
1706 set buftype=nofile
1707 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1708 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1709 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1710 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1711 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1712
1713 let r = sign_jump(5, '', 'foo')
1714 call assert_equal(2, r)
1715 call assert_equal(2, line('.'))
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001716 let r = 6->sign_jump('g1', 'foo')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001717 call assert_equal(5, r)
1718 call assert_equal(5, line('.'))
1719 let r = sign_jump(5, '', 'bar')
1720 call assert_equal(2, r)
1721 call assert_equal(2, line('.'))
1722
1723 " Error cases
1724 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1725 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1726 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1727 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1728 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001729 call assert_fails('call sign_jump(2, "", {})', 'E731:')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001730 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1731
1732 sign unplace * group=*
1733 sign undefine sign1
1734 enew! | only!
1735endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001736
1737" Test for correct cursor position after the sign column appears or disappears.
1738func Test_sign_cursor_position()
Bram Moolenaar494e9062020-05-31 21:28:02 +02001739 CheckRunVimInTerminal
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001740
1741 let lines =<< trim END
1742 call setline(1, [repeat('x', 75), 'mmmm', 'yyyy'])
1743 call cursor(2,1)
1744 sign define s1 texthl=Search text==>
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001745 sign define s2 linehl=Pmenu
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001746 redraw
1747 sign place 10 line=2 name=s1
1748 END
1749 call writefile(lines, 'XtestSigncolumn')
1750 let buf = RunVimInTerminal('-S XtestSigncolumn', {'rows': 6})
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001751 call VerifyScreenDump(buf, 'Test_sign_cursor_1', {})
1752
1753 " Change the sign text
1754 call term_sendkeys(buf, ":sign define s1 text=-)\<CR>")
1755 call VerifyScreenDump(buf, 'Test_sign_cursor_2', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001756
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001757 " Also place a line HL sign
1758 call term_sendkeys(buf, ":sign place 11 line=2 name=s2\<CR>")
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001759 call VerifyScreenDump(buf, 'Test_sign_cursor_3', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001760
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001761 " update cursor position calculation
1762 call term_sendkeys(buf, "lh")
1763 call term_sendkeys(buf, ":sign unplace 11\<CR>")
1764 call term_sendkeys(buf, ":sign unplace 10\<CR>")
1765 call VerifyScreenDump(buf, 'Test_sign_cursor_4', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001766
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001767 " 'cursorline' highlighting overrules sign
1768 call term_sendkeys(buf, ":sign place 12 line=2 name=s2\<CR>")
1769 call term_sendkeys(buf, ":set cursorline\<CR>")
1770 call term_sendkeys(buf, ":hi CursorLine ctermbg=Green\<CR>")
1771 call term_sendkeys(buf, "2G")
1772 call term_sendkeys(buf, ":\<CR>")
1773 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
1774
1775 " sign highlighting overrules 'cursorline'
1776 call term_sendkeys(buf, ":sign unplace 12\<CR>")
1777 call term_sendkeys(buf, ":sign place 13 line=2 priority=100 name=s2\<CR>")
1778 call term_sendkeys(buf, ":\<CR>")
1779 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
1780
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001781 " clean up
1782 call StopVimInTerminal(buf)
1783 call delete('XtestSigncolumn')
1784endfunc
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001785
1786" Return the 'len' characters in screen starting from (row,col)
1787func s:ScreenLine(row, col, len)
1788 let s = ''
1789 for i in range(a:len)
1790 let s .= nr2char(screenchar(a:row, a:col + i))
1791 endfor
1792 return s
1793endfunc
1794
1795" Test for 'signcolumn' set to 'number'.
1796func Test_sign_numcol()
1797 new
1798 call append(0, "01234")
1799 " With 'signcolumn' set to 'number', make sure sign is displayed in the
1800 " number column and line number is not displayed.
1801 set numberwidth=2
1802 set number
1803 set signcolumn=number
1804 sign define sign1 text==>
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001805 sign define sign2 text=V
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001806 sign place 10 line=1 name=sign1
1807 redraw!
1808 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1809
1810 " With 'signcolumn' set to 'number', when there is no sign, make sure line
1811 " number is displayed in the number column
1812 sign unplace 10
1813 redraw!
1814 call assert_equal("1 01234", s:ScreenLine(1, 1, 7))
1815
1816 " Disable number column. Check whether sign is displayed in the sign column
1817 set numberwidth=4
1818 set nonumber
1819 sign place 10 line=1 name=sign1
1820 redraw!
1821 call assert_equal("=>01234", s:ScreenLine(1, 1, 7))
1822
1823 " Enable number column. Check whether sign is displayed in the number column
1824 set number
1825 redraw!
Bram Moolenaar4dff4ae2019-06-19 16:31:28 +02001826 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001827
1828 " Disable sign column. Make sure line number is displayed
1829 set signcolumn=no
1830 redraw!
1831 call assert_equal(" 1 01234", s:ScreenLine(1, 1, 9))
1832
1833 " Enable auto sign column. Make sure both sign and line number are displayed
1834 set signcolumn=auto
1835 redraw!
1836 call assert_equal("=> 1 01234", s:ScreenLine(1, 1, 11))
1837
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001838 " Test displaying signs in the number column with width 1
1839 call sign_unplace('*')
1840 call append(1, "abcde")
1841 call append(2, "01234")
1842 " Enable number column with width 1
1843 set number numberwidth=1 signcolumn=auto
1844 redraw!
1845 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1846 " Place a sign and make sure number column width remains the same
1847 sign place 20 line=2 name=sign1
1848 redraw!
1849 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1850 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1851 " Set 'signcolumn' to 'number', make sure the number column width increases
1852 set signcolumn=number
1853 redraw!
1854 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1855 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1856 " Set 'signcolumn' to 'auto', make sure the number column width is 1.
1857 set signcolumn=auto
1858 redraw!
1859 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1860 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1861 " Set 'signcolumn' to 'number', make sure the number column width is 2.
1862 set signcolumn=number
1863 redraw!
1864 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1865 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1866 " Disable 'number' column
1867 set nonumber
1868 redraw!
1869 call assert_equal("=>abcde", s:ScreenLine(2, 1, 7))
1870 call assert_equal(" 01234", s:ScreenLine(3, 1, 7))
1871 " Enable 'number' column
1872 set number
1873 redraw!
1874 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1875 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1876 " Remove the sign and make sure the width of the number column is 1.
1877 call sign_unplace('', {'id' : 20})
1878 redraw!
1879 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1880 " When the first sign is placed with 'signcolumn' set to number, verify that
1881 " the number column width increases
1882 sign place 30 line=1 name=sign1
1883 redraw!
1884 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1885 call assert_equal(" 2 abcde", s:ScreenLine(2, 1, 8))
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001886 " Add sign with multi-byte text
1887 set numberwidth=4
1888 sign place 40 line=2 name=sign2
1889 redraw!
1890 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
1891 call assert_equal(" V abcde", s:ScreenLine(2, 1, 9))
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001892
1893 sign unplace * group=*
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001894 sign undefine sign1
1895 set signcolumn&
1896 set number&
1897 enew! | close
1898endfunc
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001899
1900" Test for managing multiple signs using the sign functions
1901func Test_sign_funcs_multi()
1902 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1903 edit Xsign
1904 let bnum = bufnr('')
1905
1906 " Define multiple signs at once
1907 call assert_equal([0, 0, 0, 0], sign_define([
1908 \ {'name' : 'sign1', 'text' : '=>', 'linehl' : 'Search',
1909 \ 'texthl' : 'Search'},
1910 \ {'name' : 'sign2', 'text' : '=>', 'linehl' : 'Search',
1911 \ 'texthl' : 'Search'},
1912 \ {'name' : 'sign3', 'text' : '=>', 'linehl' : 'Search',
1913 \ 'texthl' : 'Search'},
1914 \ {'name' : 'sign4', 'text' : '=>', 'linehl' : 'Search',
1915 \ 'texthl' : 'Search'}]))
1916
1917 " Negative cases for sign_define()
1918 call assert_equal([], sign_define([]))
1919 call assert_equal([-1], sign_define([{}]))
1920 call assert_fails('call sign_define([6])', 'E715:')
1921 call assert_fails('call sign_define(["abc"])', 'E715:')
1922 call assert_fails('call sign_define([[]])', 'E715:')
1923
1924 " Place multiple signs at once with specific sign identifier
1925 let l = sign_placelist([{'id' : 1, 'group' : 'g1', 'name' : 'sign1',
1926 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 50},
1927 \ {'id' : 2, 'group' : 'g2', 'name' : 'sign2',
1928 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 100},
1929 \ {'id' : 3, 'group' : '', 'name' : 'sign3',
1930 \ 'buffer' : 'Xsign', 'lnum' : 11}])
1931 call assert_equal([1, 2, 3], l)
1932 let s = sign_getplaced('Xsign', {'group' : '*'})
1933 call assert_equal([
1934 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11,
1935 \ 'group' : 'g2', 'priority' : 100},
1936 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1937 \ 'group' : 'g1', 'priority' : 50},
1938 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11,
1939 \ 'group' : '', 'priority' : 10}], s[0].signs)
1940
1941 call sign_unplace('*')
1942
1943 " Place multiple signs at once with auto-generated sign identifier
1944 call assert_equal([1, 1, 5], sign_placelist([
1945 \ {'group' : 'g1', 'name' : 'sign1',
1946 \ 'buffer' : 'Xsign', 'lnum' : 11},
1947 \ {'group' : 'g2', 'name' : 'sign2',
1948 \ 'buffer' : 'Xsign', 'lnum' : 11},
1949 \ {'group' : '', 'name' : 'sign3',
1950 \ 'buffer' : 'Xsign', 'lnum' : 11}]))
1951 let s = sign_getplaced('Xsign', {'group' : '*'})
1952 call assert_equal([
1953 \ {'id' : 5, 'name' : 'sign3', 'lnum' : 11,
1954 \ 'group' : '', 'priority' : 10},
1955 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 11,
1956 \ 'group' : 'g2', 'priority' : 10},
1957 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1958 \ 'group' : 'g1', 'priority' : 10}], s[0].signs)
1959
1960 " Change an existing sign without specifying the group
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001961 call assert_equal([5], [{'id' : 5, 'name' : 'sign1', 'buffer' : 'Xsign'}]->sign_placelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001962 let s = sign_getplaced('Xsign', {'id' : 5, 'group' : ''})
1963 call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
1964 \ 'group' : '', 'priority' : 10}], s[0].signs)
1965
Bram Moolenaar42aff462019-08-21 13:20:29 +02001966 " Place a sign using '.' as the line number
1967 call cursor(23, 1)
1968 call assert_equal([7], sign_placelist([
1969 \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
1970 let s = sign_getplaced('%', {'lnum' : '.'})
1971 call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
1972 \ 'group' : '', 'priority' : 10}], s[0].signs)
1973
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001974 " Place sign without a sign name
1975 call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
1976 \ 'lnum' : 12, 'group' : ''}]))
1977
1978 " Place sign without a buffer
1979 call assert_equal([-1], sign_placelist([{'id' : 10, 'name' : 'sign1',
1980 \ 'lnum' : 12, 'group' : ''}]))
1981
1982 " Invalid arguments
1983 call assert_equal([], sign_placelist([]))
1984 call assert_fails('call sign_placelist({})', "E714:")
1985 call assert_fails('call sign_placelist([[]])', "E715:")
1986 call assert_fails('call sign_placelist(["abc"])', "E715:")
1987 call assert_fails('call sign_placelist([100])', "E715:")
1988
1989 " Unplace multiple signs
1990 call assert_equal([0, 0, 0], sign_unplacelist([{'id' : 5},
1991 \ {'id' : 1, 'group' : 'g1'}, {'id' : 1, 'group' : 'g2'}]))
1992
1993 " Invalid arguments
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001994 call assert_equal([], []->sign_unplacelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001995 call assert_fails('call sign_unplacelist({})', "E714:")
1996 call assert_fails('call sign_unplacelist([[]])', "E715:")
1997 call assert_fails('call sign_unplacelist(["abc"])', "E715:")
1998 call assert_fails('call sign_unplacelist([100])', "E715:")
Bram Moolenaare2e40752020-09-04 21:18:46 +02001999 call assert_fails("call sign_unplacelist([{'id' : -1}])", 'E474:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002000
2001 call assert_equal([0, 0, 0, 0],
2002 \ sign_undefine(['sign1', 'sign2', 'sign3', 'sign4']))
2003 call assert_equal([], sign_getdefined())
2004
2005 " Invalid arguments
2006 call assert_equal([], sign_undefine([]))
2007 call assert_fails('call sign_undefine([[]])', 'E730:')
2008 call assert_fails('call sign_undefine([{}])', 'E731:')
2009 call assert_fails('call sign_undefine(["1abc2"])', 'E155:')
2010
2011 call sign_unplace('*')
2012 call sign_undefine()
2013 enew!
2014 call delete("Xsign")
2015endfunc
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002016
Bram Moolenaar5c56da42021-08-28 14:42:25 +02002017func Test_sign_null_list()
2018 eval test_null_list()->sign_define()
2019 eval test_null_list()->sign_placelist()
2020 eval test_null_list()->sign_undefine()
2021 eval test_null_list()->sign_unplacelist()
2022endfunc
2023
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002024" vim: shiftwidth=2 sts=2 expandtab