blob: 18a6edc772907f7792550438e390719ea7bfd484 [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
Bram Moolenaar5e18ccc2021-12-05 13:02:50 +0000129 call assert_fails("sign define Sign4 linehl=", 'E1249: Group name missing for linehl')
130 call assert_fails("sign define Sign4 culhl=", 'E1249: Group name missing for culhl')
131 call assert_fails("sign define Sign4 texthl=", 'E1249: Group name missing for texthl')
132
Bram Moolenaar06b056e2018-12-14 19:37:08 +0100133 " define sign with whitespace
134 sign define Sign4 text=\ X linehl=Comment
135 sign undefine Sign4
136 sign define Sign4 linehl=Comment text=\ X
137 sign undefine Sign4
138
139 sign define Sign5 text=X\ linehl=Comment
140 sign undefine Sign5
141 sign define Sign5 linehl=Comment text=X\
142 sign undefine Sign5
143
144 " define sign with backslash
145 sign define Sign4 text=\\\\ linehl=Comment
146 sign undefine Sign4
147 sign define Sign4 text=\\ linehl=Comment
148 sign undefine Sign4
149
Bram Moolenaara3556522018-12-31 22:02:29 +0100150 " define a sign with a leading 0 in the name
151 sign unplace *
152 sign define 004 text=#> linehl=Comment
153 let a = execute('sign list 4')
154 call assert_equal("\nsign 4 text=#> linehl=Comment", a)
155 exe 'sign place 20 line=3 name=004 buffer=' . bufnr('')
156 let a = execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100157 call assert_equal("\n--- Signs ---\nSigns for foo:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100158 \ " line=3 id=20 name=4 priority=10\n", a)
Bram Moolenaara3556522018-12-31 22:02:29 +0100159 exe 'sign unplace 20 buffer=' . bufnr('')
160 sign undefine 004
161 call assert_fails('sign list 4', 'E155:')
162
Bram Moolenaar09de1752016-08-08 22:26:48 +0200163 " After undefining the sign, we should no longer be able to place it.
164 sign undefine Sign1
165 sign undefine Sign2
Bram Moolenaar446a9732016-08-10 21:36:23 +0200166 sign undefine Sign3
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100167 call assert_fails("sign place 41 line=3 name=Sign1 buffer=" .
168 \ bufnr('%'), 'E155:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200169endfunc
Bram Moolenaar09de1752016-08-08 22:26:48 +0200170
Bram Moolenaar446a9732016-08-10 21:36:23 +0200171" Undefining placed sign is not recommended.
172" Quoting :help sign
173"
174" :sign undefine {name}
175" Deletes a previously defined sign. If signs with this {name}
176" are still placed this will cause trouble.
177func Test_sign_undefine_still_placed()
178 new foobar
179 sign define Sign text=x
180 exe 'sign place 41 line=1 name=Sign buffer=' . bufnr('%')
181 sign undefine Sign
182
183 " Listing placed sign should show that sign is deleted.
184 let a=execute('sign place')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100185 call assert_equal("\n--- Signs ---\nSigns for foobar:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100186 \ " line=1 id=41 name=[Deleted] priority=10\n", a)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200187
188 sign unplace 41
189 let a=execute('sign place')
190 call assert_equal("\n--- Signs ---\n", a)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200191endfunc
192
193func Test_sign_completion()
194 sign define Sign1 text=x
195 sign define Sign2 text=y
196
197 call feedkeys(":sign \<C-A>\<C-B>\"\<CR>", 'tx')
198 call assert_equal('"sign define jump list place undefine unplace', @:)
199
200 call feedkeys(":sign define Sign \<C-A>\<C-B>\"\<CR>", 'tx')
201 call assert_equal('"sign define Sign icon= linehl= text= texthl=', @:)
202
203 call feedkeys(":sign define Sign linehl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100204 call assert_equal('"sign define Sign linehl=SpellBad SpellCap ' .
205 \ 'SpellLocal SpellRare', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200206
Bram Moolenaar3678f652019-02-17 14:50:25 +0100207 call feedkeys(":sign define Sign texthl=Spell\<C-A>\<C-B>\"\<CR>", 'tx')
208 call assert_equal('"sign define Sign texthl=SpellBad SpellCap ' .
209 \ 'SpellLocal SpellRare', @:)
210
211 call writefile(repeat(["Sun is shining"], 30), "XsignOne")
212 call writefile(repeat(["Sky is blue"], 30), "XsignTwo")
Bram Moolenaar64cefed2016-08-29 23:06:28 +0200213 call feedkeys(":sign define Sign icon=Xsig\<C-A>\<C-B>\"\<CR>", 'tx')
214 call assert_equal('"sign define Sign icon=XsignOne XsignTwo', @:)
Bram Moolenaar446a9732016-08-10 21:36:23 +0200215
Bram Moolenaar3678f652019-02-17 14:50:25 +0100216 " Test for completion of arguments to ':sign undefine'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200217 call feedkeys(":sign undefine \<C-A>\<C-B>\"\<CR>", 'tx')
218 call assert_equal('"sign undefine Sign1 Sign2', @:)
219
220 call feedkeys(":sign place 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100221 call assert_equal('"sign place 1 buffer= file= group= line= name= priority=',
222 \ @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200223
224 call feedkeys(":sign place 1 name=\<C-A>\<C-B>\"\<CR>", 'tx')
225 call assert_equal('"sign place 1 name=Sign1 Sign2', @:)
226
Bram Moolenaar3678f652019-02-17 14:50:25 +0100227 edit XsignOne
228 sign place 1 name=Sign1 line=5
229 sign place 1 name=Sign1 group=g1 line=10
230 edit XsignTwo
231 sign place 1 name=Sign2 group=g2 line=15
232
233 " Test for completion of group= and file= arguments to ':sign place'
234 call feedkeys(":sign place 1 name=Sign1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
235 call assert_equal('"sign place 1 name=Sign1 file=XsignOne XsignTwo', @:)
236 call feedkeys(":sign place 1 name=Sign1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
237 call assert_equal('"sign place 1 name=Sign1 group=g1 g2', @:)
238
239 " Test for completion of arguments to 'sign place' without sign identifier
240 call feedkeys(":sign place \<C-A>\<C-B>\"\<CR>", 'tx')
241 call assert_equal('"sign place buffer= file= group=', @:)
242 call feedkeys(":sign place file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
243 call assert_equal('"sign place file=XsignOne XsignTwo', @:)
244 call feedkeys(":sign place group=\<C-A>\<C-B>\"\<CR>", 'tx')
245 call assert_equal('"sign place group=g1 g2', @:)
246 call feedkeys(":sign place group=g1 file=\<C-A>\<C-B>\"\<CR>", 'tx')
247 call assert_equal('"sign place group=g1 file=XsignOne XsignTwo', @:)
248
249 " Test for completion of arguments to ':sign unplace'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200250 call feedkeys(":sign unplace 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100251 call assert_equal('"sign unplace 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100252 call feedkeys(":sign unplace 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
253 call assert_equal('"sign unplace 1 file=XsignOne XsignTwo', @:)
254 call feedkeys(":sign unplace 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
255 call assert_equal('"sign unplace 1 group=g1 g2', @:)
256 call feedkeys(":sign unplace 1 group=g2 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
257 call assert_equal('"sign unplace 1 group=g2 file=XsignOne XsignTwo', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200258
Bram Moolenaar3678f652019-02-17 14:50:25 +0100259 " Test for completion of arguments to ':sign list'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200260 call feedkeys(":sign list \<C-A>\<C-B>\"\<CR>", 'tx')
261 call assert_equal('"sign list Sign1 Sign2', @:)
262
Bram Moolenaar3678f652019-02-17 14:50:25 +0100263 " Test for completion of arguments to ':sign jump'
Bram Moolenaar09de1752016-08-08 22:26:48 +0200264 call feedkeys(":sign jump 1 \<C-A>\<C-B>\"\<CR>", 'tx')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100265 call assert_equal('"sign jump 1 buffer= file= group=', @:)
Bram Moolenaar3678f652019-02-17 14:50:25 +0100266 call feedkeys(":sign jump 1 file=Xsign\<C-A>\<C-B>\"\<CR>", 'tx')
267 call assert_equal('"sign jump 1 file=XsignOne XsignTwo', @:)
268 call feedkeys(":sign jump 1 group=\<C-A>\<C-B>\"\<CR>", 'tx')
269 call assert_equal('"sign jump 1 group=g1 g2', @:)
Bram Moolenaar09de1752016-08-08 22:26:48 +0200270
Bram Moolenaar3678f652019-02-17 14:50:25 +0100271 " Error cases
272 call feedkeys(":sign here\<C-A>\<C-B>\"\<CR>", 'tx')
273 call assert_equal('"sign here', @:)
274 call feedkeys(":sign define Sign here=\<C-A>\<C-B>\"\<CR>", 'tx')
275 call assert_equal("\"sign define Sign here=\<C-A>", @:)
276 call feedkeys(":sign place 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
277 call assert_equal("\"sign place 1 here=\<C-A>", @:)
278 call feedkeys(":sign jump 1 here=\<C-A>\<C-B>\"\<CR>", 'tx')
279 call assert_equal("\"sign jump 1 here=\<C-A>", @:)
280 call feedkeys(":sign here there\<C-A>\<C-B>\"\<CR>", 'tx')
281 call assert_equal("\"sign here there\<C-A>", @:)
282 call feedkeys(":sign here there=\<C-A>\<C-B>\"\<CR>", 'tx')
283 call assert_equal("\"sign here there=\<C-A>", @:)
284
285 sign unplace * group=*
Bram Moolenaar09de1752016-08-08 22:26:48 +0200286 sign undefine Sign1
287 sign undefine Sign2
Bram Moolenaar3678f652019-02-17 14:50:25 +0100288 enew
289 call delete('XsignOne')
290 call delete('XsignTwo')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200291endfunc
292
293func Test_sign_invalid_commands()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100294 sign define Sign1 text=x
295
Bram Moolenaar09de1752016-08-08 22:26:48 +0200296 call assert_fails('sign', 'E471:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200297 call assert_fails('sign jump', 'E471:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200298 call assert_fails('sign xxx', 'E160:')
299 call assert_fails('sign define', 'E156:')
Bram Moolenaar446a9732016-08-10 21:36:23 +0200300 call assert_fails('sign define Sign1 xxx', 'E475:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200301 call assert_fails('sign undefine', 'E156:')
302 call assert_fails('sign list xxx', 'E155:')
Bram Moolenaarcf1ba352017-10-27 00:55:04 +0200303 call assert_fails('sign place 1 buffer=999', 'E158:')
Bram Moolenaara3556522018-12-31 22:02:29 +0100304 call assert_fails('sign place 1 name=Sign1 buffer=999', 'E158:')
305 call assert_fails('sign place buffer=999', 'E158:')
306 call assert_fails('sign jump buffer=999', 'E158:')
307 call assert_fails('sign jump 1 file=', 'E158:')
308 call assert_fails('sign jump 1 group=', 'E474:')
309 call assert_fails('sign jump 1 name=', 'E474:')
310 call assert_fails('sign jump 1 name=Sign1', 'E474:')
311 call assert_fails('sign jump 1 line=100', '474:')
Bram Moolenaar09de1752016-08-08 22:26:48 +0200312 call assert_fails('sign define Sign2 text=', 'E239:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100313 " Non-numeric identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100314 call assert_fails("sign place abc line=3 name=Sign1 buffer=" . bufnr(''),
315 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100316 " Non-numeric identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100317 call assert_fails("sign unplace abc name=Sign1 buffer=" . bufnr(''),
318 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100319 " Number followed by an alphabet as sign identifier for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100320 call assert_fails("sign place 1abc line=3 name=Sign1 buffer=" . bufnr(''),
321 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100322 " Number followed by an alphabet as sign identifier for :sign unplace
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100323 call assert_fails("sign unplace 2abc name=Sign1 buffer=" . bufnr(''),
324 \ 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100325 " Sign identifier and '*' for :sign unplace
326 call assert_fails("sign unplace 2 *", 'E474:')
327 " Trailing characters after buffer number for :sign place
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100328 call assert_fails("sign place 1 line=3 name=Sign1 buffer=" .
329 \ bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100330 " Trailing characters after buffer number for :sign unplace
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100331 call assert_fails("sign unplace 1 buffer=" . bufnr('%') . 'xxx', 'E488:')
332 call assert_fails("sign unplace * buffer=" . bufnr('%') . 'xxx', 'E488:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100333 call assert_fails("sign unplace 1 xxx", 'E474:')
334 call assert_fails("sign unplace * xxx", 'E474:')
335 call assert_fails("sign unplace xxx", 'E474:')
336 " Placing a sign without line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100337 call assert_fails("sign place name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100338 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100339 call assert_fails("sign place line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100340 " Unplacing a sign with line number
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100341 call assert_fails("sign unplace 2 line=10 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100342 " Unplacing a sign with sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100343 call assert_fails("sign unplace 2 name=Sign1 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100344 " Placing a sign without sign name
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100345 call assert_fails("sign place 2 line=3 buffer=" . bufnr('%'), 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100346 " Placing a sign with only sign identifier
347 call assert_fails("sign place 2", 'E474:')
348 " Placing a sign with only a name
349 call assert_fails("sign place abc", 'E474:')
350 " Placing a sign with only line number
351 call assert_fails("sign place 5 line=3", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100352 " Placing a sign with only sign group
353 call assert_fails("sign place 5 group=g1", 'E474:')
354 call assert_fails("sign place 5 group=*", 'E474:')
355 " Placing a sign with only sign priority
356 call assert_fails("sign place 5 priority=10", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100357
358 sign undefine Sign1
Bram Moolenaar09de1752016-08-08 22:26:48 +0200359endfunc
Bram Moolenaarbfd096d2016-08-17 22:29:09 +0200360
361func Test_sign_delete_buffer()
362 new
363 sign define Sign text=x
364 let bufnr = bufnr('%')
365 new
366 exe 'bd ' . bufnr
367 exe 'sign place 61 line=3 name=Sign buffer=' . bufnr
368 call assert_fails('sign jump 61 buffer=' . bufnr, 'E934:')
369 sign unplace 61
370 sign undefine Sign
371endfunc
Bram Moolenaar162b7142018-12-21 15:17:36 +0100372
Bram Moolenaard933c822019-08-21 13:45:16 +0200373" Ignore error: E255: Couldn't read in sign data!
374" This error can happen when running in the GUI.
375" Some gui like Motif do not support the png icon format.
376func Sign_command_ignore_error(cmd)
377 try
378 exe a:cmd
379 catch /E255:/
380 endtry
381endfunc
382
383" ignore error: E255: Couldn't read in sign data!
384" This error can happen when running in gui.
385func Sign_define_ignore_error(name, attr)
386 try
387 call sign_define(a:name, a:attr)
388 catch /E255:/
389 endtry
390endfunc
391
Bram Moolenaar6436cd82018-12-27 00:28:33 +0100392" Test for Vim script functions for managing signs
Bram Moolenaar162b7142018-12-21 15:17:36 +0100393func Test_sign_funcs()
394 " Remove all the signs
395 call sign_unplace('*')
396 call sign_undefine()
397
398 " Tests for sign_define()
Bram Moolenaare413ea02021-11-24 16:20:13 +0000399 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error',
400 \ 'culhl': 'Visual'}
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200401 call assert_equal(0, "sign1"->sign_define(attr))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100402 call assert_equal([{'name' : 'sign1', 'texthl' : 'Error',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000403 \ 'linehl' : 'Search', 'culhl' : 'Visual', 'text' : '=>'}],
404 \ sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100405
406 " Define a new sign without attributes and then update it
407 call sign_define("sign2")
408 let attr = {'text' : '!!', 'linehl' : 'DiffAdd', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000409 \ 'culhl': 'DiffDelete', 'icon' : 'sign2.ico'}
Bram Moolenaard933c822019-08-21 13:45:16 +0200410 call Sign_define_ignore_error("sign2", attr)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100411 call assert_equal([{'name' : 'sign2', 'texthl' : 'DiffChange',
Bram Moolenaare413ea02021-11-24 16:20:13 +0000412 \ 'linehl' : 'DiffAdd', 'culhl' : 'DiffDelete', 'text' : '!!',
413 \ 'icon' : 'sign2.ico'}], "sign2"->sign_getdefined())
Bram Moolenaar162b7142018-12-21 15:17:36 +0100414
415 " Test for a sign name with digits
416 call assert_equal(0, sign_define(0002, {'linehl' : 'StatusLine'}))
417 call assert_equal([{'name' : '2', 'linehl' : 'StatusLine'}],
418 \ sign_getdefined(0002))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200419 eval 0002->sign_undefine()
Bram Moolenaar162b7142018-12-21 15:17:36 +0100420
421 " Tests for invalid arguments to sign_define()
422 call assert_fails('call sign_define("sign4", {"text" : "===>"})', 'E239:')
423 call assert_fails('call sign_define("sign5", {"text" : ""})', 'E239:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200424 call assert_fails('call sign_define({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100425 call assert_fails('call sign_define("sign6", [])', 'E715:')
426
427 " Tests for sign_getdefined()
428 call assert_equal([], sign_getdefined("none"))
429 call assert_fails('call sign_getdefined({})', 'E731:')
430
431 " Tests for sign_place()
432 call writefile(repeat(["Sun is shining"], 30), "Xsign")
433 edit Xsign
434
435 call assert_equal(10, sign_place(10, '', 'sign1', 'Xsign',
436 \ {'lnum' : 20}))
437 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
438 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
439 \ 'priority' : 10}]}], sign_getplaced('Xsign'))
440 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
441 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
442 \ 'priority' : 10}]}],
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200443 \ '%'->sign_getplaced({'lnum' : 20}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100444 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
445 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
446 \ 'priority' : 10}]}],
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100447 \ sign_getplaced('', {'id' : 10}))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100448
449 " Tests for invalid arguments to sign_place()
450 call assert_fails('call sign_place([], "", "mySign", 1)', 'E745:')
451 call assert_fails('call sign_place(5, "", "mySign", -1)', 'E158:')
452 call assert_fails('call sign_place(-1, "", "sign1", "Xsign", [])',
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200453 \ 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100454 call assert_fails('call sign_place(-1, "", "sign1", "Xsign",
455 \ {"lnum" : 30})', 'E474:')
456 call assert_fails('call sign_place(10, "", "xsign1x", "Xsign",
457 \ {"lnum" : 30})', 'E155:')
458 call assert_fails('call sign_place(10, "", "", "Xsign",
459 \ {"lnum" : 30})', 'E155:')
460 call assert_fails('call sign_place(10, "", [], "Xsign",
461 \ {"lnum" : 30})', 'E730:')
462 call assert_fails('call sign_place(5, "", "sign1", "abcxyz.xxx",
463 \ {"lnum" : 10})', 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100464 call assert_fails('call sign_place(5, "", "sign1", "@", {"lnum" : 10})',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100465 \ 'E158:')
466 call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200467 \ 'E730:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100468 call assert_fails('call sign_place(21, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200469 \ {"lnum" : -1})', 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100470 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar42aff462019-08-21 13:20:29 +0200471 \ {"lnum" : 0})', 'E474:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100472 call assert_fails('call sign_place(22, "", "sign1", "Xsign",
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200473 \ {"lnum" : []})', 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100474 call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
475
476 " Tests for sign_getplaced()
477 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
478 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
479 \ 'priority' : 10}]}],
480 \ sign_getplaced(bufnr('Xsign')))
481 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
482 \ [{'id' : 10, 'group' : '', 'lnum' : 20, 'name' : 'sign1',
483 \ 'priority' : 10}]}],
484 \ sign_getplaced())
485 call assert_fails("call sign_getplaced('dummy.sign')", 'E158:')
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100486 call assert_fails('call sign_getplaced("&")', 'E158:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100487 call assert_fails('call sign_getplaced(-1)', 'E158:')
488 call assert_fails('call sign_getplaced("Xsign", [])', 'E715:')
489 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
490 \ sign_getplaced('Xsign', {'lnum' : 1000000}))
491 call assert_fails("call sign_getplaced('Xsign', {'lnum' : []})",
492 \ 'E745:')
493 call assert_equal([{'bufnr' : bufnr(''), 'signs' : []}],
494 \ sign_getplaced('Xsign', {'id' : 44}))
495 call assert_fails("call sign_getplaced('Xsign', {'id' : []})",
496 \ 'E745:')
497
498 " Tests for sign_unplace()
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200499 eval 20->sign_place('', 'sign2', 'Xsign', {"lnum" : 30})
Bram Moolenaar162b7142018-12-21 15:17:36 +0100500 call assert_equal(0, sign_unplace('',
501 \ {'id' : 20, 'buffer' : 'Xsign'}))
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200502 call assert_equal(-1, ''->sign_unplace(
Bram Moolenaar162b7142018-12-21 15:17:36 +0100503 \ {'id' : 30, 'buffer' : 'Xsign'}))
504 call sign_place(20, '', 'sign2', 'Xsign', {"lnum" : 30})
505 call assert_fails("call sign_unplace('',
506 \ {'id' : 20, 'buffer' : 'buffer.c'})", 'E158:')
507 call assert_fails("call sign_unplace('',
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +0100508 \ {'id' : 20, 'buffer' : '&'})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100509 call assert_fails("call sign_unplace('g1',
Bram Moolenaar162b7142018-12-21 15:17:36 +0100510 \ {'id' : 20, 'buffer' : 200})", 'E158:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100511 call assert_fails("call sign_unplace('g1', 'mySign')", 'E715:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100512
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200513 call sign_unplace('*')
514
515 " Test for modifying a placed sign
516 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign', {'lnum' : 20}))
517 call assert_equal(15, sign_place(15, '', 'sign2', 'Xsign'))
518 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
519 \ [{'id' : 15, 'group' : '', 'lnum' : 20, 'name' : 'sign2',
520 \ 'priority' : 10}]}],
521 \ sign_getplaced())
522
Bram Moolenaar162b7142018-12-21 15:17:36 +0100523 " Tests for sign_undefine()
524 call assert_equal(0, sign_undefine("sign1"))
525 call assert_equal([], sign_getdefined("sign1"))
526 call assert_fails('call sign_undefine("none")', 'E155:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200527 call assert_fails('call sign_undefine({})', 'E731:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100528
Bram Moolenaar42aff462019-08-21 13:20:29 +0200529 " Test for using '.' as the line number for sign_place()
Bram Moolenaard933c822019-08-21 13:45:16 +0200530 call Sign_define_ignore_error("sign1", attr)
Bram Moolenaar42aff462019-08-21 13:20:29 +0200531 call cursor(22, 1)
532 call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
533 \ {'lnum' : '.'}))
534 call assert_equal([{'bufnr' : bufnr(''), 'signs' :
535 \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
536 \ 'priority' : 10}]}],
537 \ sign_getplaced('%', {'lnum' : 22}))
538
Bram Moolenaar162b7142018-12-21 15:17:36 +0100539 call delete("Xsign")
540 call sign_unplace('*')
541 call sign_undefine()
542 enew | only
543endfunc
544
545" Tests for sign groups
546func Test_sign_group()
547 enew | only
548 " Remove all the signs
549 call sign_unplace('*')
550 call sign_undefine()
551
552 call writefile(repeat(["Sun is shining"], 30), "Xsign")
553
554 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
555 call assert_equal(0, sign_define("sign1", attr))
556
557 edit Xsign
558 let bnum = bufnr('%')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100559
560 " Error case
561 call assert_fails("call sign_place(5, [], 'sign1', 'Xsign',
562 \ {'lnum' : 30})", 'E730:')
563
564 " place three signs with the same identifier. One in the global group and
565 " others in the named groups
566 call assert_equal(5, sign_place(5, '', 'sign1', 'Xsign',
567 \ {'lnum' : 10}))
568 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 20}))
569 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 30}))
570
571 " Test for sign_getplaced() with group
572 let s = sign_getplaced('Xsign')
573 call assert_equal(1, len(s[0].signs))
574 call assert_equal(s[0].signs[0].group, '')
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100575 let s = sign_getplaced(bnum, {'group' : ''})
576 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
577 \ 'priority' : 10}], s[0].signs)
578 call assert_equal(1, len(s[0].signs))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100579 let s = sign_getplaced(bnum, {'group' : 'g2'})
580 call assert_equal('g2', s[0].signs[0].group)
581 let s = sign_getplaced(bnum, {'group' : 'g3'})
582 call assert_equal([], s[0].signs)
583 let s = sign_getplaced(bnum, {'group' : '*'})
584 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
585 \ 'priority' : 10},
586 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
587 \ 'priority' : 10},
588 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
589 \ 'priority' : 10}],
590 \ s[0].signs)
591
592 " Test for sign_getplaced() with id
593 let s = sign_getplaced(bnum, {'id' : 5})
594 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
595 \ 'priority' : 10}],
596 \ s[0].signs)
597 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g2'})
598 call assert_equal(
599 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
600 \ 'priority' : 10}],
601 \ s[0].signs)
602 let s = sign_getplaced(bnum, {'id' : 5, 'group' : '*'})
603 call assert_equal([{'id' : 5, 'group' : '', 'name' : 'sign1', 'lnum' : 10,
604 \ 'priority' : 10},
605 \ {'id' : 5, 'group' : 'g1', 'name' : 'sign1', 'lnum' : 20,
606 \ 'priority' : 10},
607 \ {'id' : 5, 'group' : 'g2', 'name' : 'sign1', 'lnum' : 30,
608 \ 'priority' : 10}],
609 \ s[0].signs)
610 let s = sign_getplaced(bnum, {'id' : 5, 'group' : 'g3'})
611 call assert_equal([], s[0].signs)
612
613 " Test for sign_getplaced() with lnum
614 let s = sign_getplaced(bnum, {'lnum' : 20})
615 call assert_equal([], s[0].signs)
616 let s = sign_getplaced(bnum, {'lnum' : 20, 'group' : 'g1'})
617 call assert_equal(
618 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
619 \ 'priority' : 10}],
620 \ s[0].signs)
621 let s = sign_getplaced(bnum, {'lnum' : 30, 'group' : '*'})
622 call assert_equal(
623 \ [{'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
624 \ 'priority' : 10}],
625 \ s[0].signs)
626 let s = sign_getplaced(bnum, {'lnum' : 40, 'group' : '*'})
627 call assert_equal([], s[0].signs)
628
629 " Error case
630 call assert_fails("call sign_getplaced(bnum, {'group' : []})",
631 \ 'E730:')
632
633 " Clear the sign in global group
634 call sign_unplace('', {'id' : 5, 'buffer' : bnum})
635 let s = sign_getplaced(bnum, {'group' : '*'})
636 call assert_equal([
637 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : 'g1',
638 \ 'priority' : 10},
639 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
640 \ 'priority' : 10}],
641 \ s[0].signs)
642
643 " Clear the sign in one of the groups
644 call sign_unplace('g1', {'buffer' : 'Xsign'})
645 let s = sign_getplaced(bnum, {'group' : '*'})
646 call assert_equal([
647 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 30, 'group' : 'g2',
648 \ 'priority' : 10}],
649 \ s[0].signs)
650
651 " Clear all the signs from the buffer
652 call sign_unplace('*', {'buffer' : bnum})
653 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
654
655 " Clear sign across groups using an identifier
656 call sign_place(25, '', 'sign1', bnum, {'lnum' : 10})
657 call sign_place(25, 'g1', 'sign1', bnum, {'lnum' : 11})
658 call sign_place(25, 'g2', 'sign1', bnum, {'lnum' : 12})
659 call assert_equal(0, sign_unplace('*', {'id' : 25}))
660 call assert_equal([], sign_getplaced(bnum, {'group' : '*'})[0].signs)
661
662 " Error case
Bram Moolenaar809ce4d2019-07-13 21:21:40 +0200663 call assert_fails("call sign_unplace({})", 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100664
665 " Place a sign in the global group and try to delete it using a group
666 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
667 call assert_equal(-1, sign_unplace('g1', {'id' : 5}))
668
669 " Place signs in multiple groups and delete all the signs in one of the
670 " group
671 call assert_equal(5, sign_place(5, '', 'sign1', bnum, {'lnum' : 10}))
672 call assert_equal(6, sign_place(6, '', 'sign1', bnum, {'lnum' : 11}))
673 call assert_equal(5, sign_place(5, 'g1', 'sign1', bnum, {'lnum' : 10}))
674 call assert_equal(5, sign_place(5, 'g2', 'sign1', bnum, {'lnum' : 10}))
675 call assert_equal(6, sign_place(6, 'g1', 'sign1', bnum, {'lnum' : 11}))
676 call assert_equal(6, sign_place(6, 'g2', 'sign1', bnum, {'lnum' : 11}))
677 call assert_equal(0, sign_unplace('g1'))
678 let s = sign_getplaced(bnum, {'group' : 'g1'})
679 call assert_equal([], s[0].signs)
680 let s = sign_getplaced(bnum)
681 call assert_equal(2, len(s[0].signs))
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('', {'id' : 5}))
685 call assert_equal(0, sign_unplace('', {'id' : 6}))
686 let s = sign_getplaced(bnum, {'group' : 'g2'})
687 call assert_equal('g2', s[0].signs[0].group)
688 call assert_equal(0, sign_unplace('', {'buffer' : bnum}))
689
690 call sign_unplace('*')
691
692 " Test for :sign command and groups
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100693 sign place 5 line=10 name=sign1 file=Xsign
694 sign place 5 group=g1 line=10 name=sign1 file=Xsign
695 sign place 5 group=g2 line=10 name=sign1 file=Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +0100696
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100697 " Tests for the ':sign place' command
698
699 " :sign place file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100700 let a = execute('sign place file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100701 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100702 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100703
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100704 " :sign place group={group} file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100705 let a = execute('sign place group=g2 file=Xsign')
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100706 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100707 \ " line=10 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100708
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100709 " :sign place group=* file={fname}
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100710 let a = execute('sign place group=* file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100711 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100712 \ " line=10 id=5 group=g2 name=sign1 priority=10\n" .
713 \ " line=10 id=5 group=g1 name=sign1 priority=10\n" .
714 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100715
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100716 " Error case: non-existing group
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100717 let a = execute('sign place group=xyz file=Xsign')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100718 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
719
720 call sign_unplace('*')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100721 let bnum = bufnr('Xsign')
722 exe 'sign place 5 line=10 name=sign1 buffer=' . bnum
723 exe 'sign place 5 group=g1 line=11 name=sign1 buffer=' . bnum
724 exe 'sign place 5 group=g2 line=12 name=sign1 buffer=' . bnum
725
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100726 " :sign place buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100727 let a = execute('sign place buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100728 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100729 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100730
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100731 " :sign place group={group} buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100732 let a = execute('sign place group=g2 buffer=' . bnum)
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100733 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100734 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100735
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100736 " :sign place group=* buffer={fname}
Bram Moolenaar162b7142018-12-21 15:17:36 +0100737 let a = execute('sign place group=* buffer=' . bnum)
738 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100739 \ " line=10 id=5 name=sign1 priority=10\n" .
740 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
741 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100742
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100743 " Error case: non-existing group
Bram Moolenaar162b7142018-12-21 15:17:36 +0100744 let a = execute('sign place group=xyz buffer=' . bnum)
745 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n", a)
746
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100747 " :sign place
748 let a = execute('sign place')
749 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100750 \ " line=10 id=5 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100751
Bram Moolenaarb589f952019-01-07 22:10:00 +0100752 " Place signs in more than one buffer and list the signs
753 split foo
754 set buftype=nofile
755 sign place 25 line=76 name=sign1 priority=99 file=foo
756 let a = execute('sign place')
757 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
758 \ " line=10 id=5 name=sign1 priority=10\n" .
759 \ "Signs for foo:\n" .
760 \ " line=76 id=25 name=sign1 priority=99\n", a)
761 close
762 bwipe foo
763
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100764 " :sign place group={group}
765 let a = execute('sign place group=g1')
766 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100767 \ " line=11 id=5 group=g1 name=sign1 priority=10\n", a)
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100768
769 " :sign place group=*
Bram Moolenaar162b7142018-12-21 15:17:36 +0100770 let a = execute('sign place group=*')
771 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +0100772 \ " line=10 id=5 name=sign1 priority=10\n" .
773 \ " line=11 id=5 group=g1 name=sign1 priority=10\n" .
774 \ " line=12 id=5 group=g2 name=sign1 priority=10\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +0100775
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100776 " Test for ':sign jump' command with groups
777 sign jump 5 group=g1 file=Xsign
778 call assert_equal(11, line('.'))
779 call assert_equal('Xsign', bufname(''))
780 sign jump 5 group=g2 file=Xsign
781 call assert_equal(12, line('.'))
Bram Moolenaar162b7142018-12-21 15:17:36 +0100782
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100783 " Test for :sign jump command without the filename or buffer
784 sign jump 5
785 call assert_equal(10, line('.'))
786 sign jump 5 group=g1
787 call assert_equal(11, line('.'))
788
Bram Moolenaar162b7142018-12-21 15:17:36 +0100789 " Error cases
Bram Moolenaar7a2d9892018-12-24 20:23:49 +0100790 call assert_fails("sign place 3 group= name=sign1 buffer=" . bnum, 'E474:')
Bram Moolenaar162b7142018-12-21 15:17:36 +0100791
792 call delete("Xsign")
793 call sign_unplace('*')
794 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +0100795 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +0100796endfunc
797
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100798" Place signs used for ":sign unplace" command test
799func Place_signs_for_test()
800 call sign_unplace('*')
801
802 sign place 3 line=10 name=sign1 file=Xsign1
803 sign place 3 group=g1 line=11 name=sign1 file=Xsign1
804 sign place 3 group=g2 line=12 name=sign1 file=Xsign1
805 sign place 4 line=15 name=sign1 file=Xsign1
806 sign place 4 group=g1 line=16 name=sign1 file=Xsign1
807 sign place 4 group=g2 line=17 name=sign1 file=Xsign1
808 sign place 5 line=20 name=sign1 file=Xsign2
809 sign place 5 group=g1 line=21 name=sign1 file=Xsign2
810 sign place 5 group=g2 line=22 name=sign1 file=Xsign2
811 sign place 6 line=25 name=sign1 file=Xsign2
812 sign place 6 group=g1 line=26 name=sign1 file=Xsign2
813 sign place 6 group=g2 line=27 name=sign1 file=Xsign2
814endfunc
815
816" Place multiple signs in a single line for test
817func Place_signs_at_line_for_test()
818 call sign_unplace('*')
819 sign place 3 line=13 name=sign1 file=Xsign1
820 sign place 3 group=g1 line=13 name=sign1 file=Xsign1
821 sign place 3 group=g2 line=13 name=sign1 file=Xsign1
822 sign place 4 line=13 name=sign1 file=Xsign1
823 sign place 4 group=g1 line=13 name=sign1 file=Xsign1
824 sign place 4 group=g2 line=13 name=sign1 file=Xsign1
825endfunc
826
827" Tests for the ':sign unplace' command
828func Test_sign_unplace()
829 enew | only
830 " Remove all the signs
831 call sign_unplace('*')
832 call sign_undefine()
833
834 " Create two files and define signs
835 call writefile(repeat(["Sun is shining"], 30), "Xsign1")
836 call writefile(repeat(["It is beautiful"], 30), "Xsign2")
837
838 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
839 call sign_define("sign1", attr)
840
841 edit Xsign1
842 let bnum1 = bufnr('%')
843 split Xsign2
844 let bnum2 = bufnr('%')
845
846 let signs1 = [{'id' : 3, 'name' : 'sign1', 'lnum' : 10, 'group' : '',
847 \ 'priority' : 10},
848 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
849 \ 'priority' : 10},
850 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 12, 'group' : 'g2',
851 \ 'priority' : 10},
852 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 15, 'group' : '',
853 \ 'priority' : 10},
854 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 16, 'group' : 'g1',
855 \ 'priority' : 10},
856 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 17, 'group' : 'g2',
857 \ 'priority' : 10},]
858 let signs2 = [{'id' : 5, 'name' : 'sign1', 'lnum' : 20, 'group' : '',
859 \ 'priority' : 10},
860 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 21, 'group' : 'g1',
861 \ 'priority' : 10},
862 \ {'id' : 5, 'name' : 'sign1', 'lnum' : 22, 'group' : 'g2',
863 \ 'priority' : 10},
864 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 25, 'group' : '',
865 \ 'priority' : 10},
866 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 26, 'group' : 'g1',
867 \ 'priority' : 10},
868 \ {'id' : 6, 'name' : 'sign1', 'lnum' : 27, 'group' : 'g2',
869 \ 'priority' : 10},]
870
871 " Test for :sign unplace {id} file={fname}
872 call Place_signs_for_test()
873 sign unplace 3 file=Xsign1
874 sign unplace 6 file=Xsign2
875 call assert_equal(
876 \ filter(copy(signs1),
877 \ {idx, val -> val.id != 3 || val.group != ''}),
878 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
879 call assert_equal(
880 \ filter(copy(signs2),
881 \ {idx, val -> val.id != 6 || val.group != ''}),
882 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
883
884 " Test for :sign unplace {id} group={group} file={fname}
885 call Place_signs_for_test()
886 sign unplace 4 group=g1 file=Xsign1
887 sign unplace 5 group=g2 file=Xsign2
888 call assert_equal(
889 \ filter(copy(signs1),
890 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
891 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
892 call assert_equal(
893 \ filter(copy(signs2),
894 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
895 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
896
897 " Test for :sign unplace {id} group=* file={fname}
898 call Place_signs_for_test()
899 sign unplace 3 group=* file=Xsign1
900 sign unplace 6 group=* file=Xsign2
901 call assert_equal(
902 \ filter(copy(signs1),
903 \ {idx, val -> val.id != 3}),
904 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
905 call assert_equal(
906 \ filter(copy(signs2),
907 \ {idx, val -> val.id != 6}),
908 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
909
910 " Test for :sign unplace * file={fname}
911 call Place_signs_for_test()
912 sign unplace * file=Xsign1
913 call assert_equal(
914 \ filter(copy(signs1),
915 \ {idx, val -> val.group != ''}),
916 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
917 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
918
919 " Test for :sign unplace * group={group} file={fname}
920 call Place_signs_for_test()
921 sign unplace * group=g1 file=Xsign1
922 sign unplace * group=g2 file=Xsign2
923 call assert_equal(
924 \ filter(copy(signs1),
925 \ {idx, val -> val.group != 'g1'}),
926 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
927 call assert_equal(
928 \ filter(copy(signs2),
929 \ {idx, val -> val.group != 'g2'}),
930 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
931
932 " Test for :sign unplace * group=* file={fname}
933 call Place_signs_for_test()
934 sign unplace * group=* file=Xsign2
935 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
936 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
937
938 " Test for :sign unplace {id} buffer={nr}
939 call Place_signs_for_test()
940 exe 'sign unplace 3 buffer=' . bnum1
941 exe 'sign unplace 6 buffer=' . bnum2
942 call assert_equal(
943 \ filter(copy(signs1),
944 \ {idx, val -> val.id != 3 || val.group != ''}),
945 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
946 call assert_equal(
947 \ filter(copy(signs2),
948 \ {idx, val -> val.id != 6 || val.group != ''}),
949 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
950
951 " Test for :sign unplace {id} group={group} buffer={nr}
952 call Place_signs_for_test()
953 exe 'sign unplace 4 group=g1 buffer=' . bnum1
954 exe 'sign unplace 5 group=g2 buffer=' . bnum2
955 call assert_equal(
956 \ filter(copy(signs1),
957 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
958 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
959 call assert_equal(
960 \ filter(copy(signs2),
961 \ {idx, val -> val.id != 5 || val.group != 'g2'}),
962 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
963
964 " Test for :sign unplace {id} group=* buffer={nr}
965 call Place_signs_for_test()
966 exe 'sign unplace 3 group=* buffer=' . bnum1
967 exe 'sign unplace 6 group=* buffer=' . bnum2
968 call assert_equal(
969 \ filter(copy(signs1),
970 \ {idx, val -> val.id != 3}),
971 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
972 call assert_equal(
973 \ filter(copy(signs2),
974 \ {idx, val -> val.id != 6}),
975 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
976
977 " Test for :sign unplace * buffer={nr}
978 call Place_signs_for_test()
979 exe 'sign unplace * buffer=' . bnum1
980 call assert_equal(
981 \ filter(copy(signs1),
982 \ {idx, val -> val.group != ''}),
983 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
984 call assert_equal(signs2, sign_getplaced(bnum2, {'group' : '*'})[0].signs)
985
986 " Test for :sign unplace * group={group} buffer={nr}
987 call Place_signs_for_test()
988 exe 'sign unplace * group=g1 buffer=' . bnum1
989 exe 'sign unplace * group=g2 buffer=' . bnum2
990 call assert_equal(
991 \ filter(copy(signs1),
992 \ {idx, val -> val.group != 'g1'}),
993 \ sign_getplaced(bnum1, {'group' : '*'})[0].signs)
994 call assert_equal(
995 \ filter(copy(signs2),
996 \ {idx, val -> val.group != 'g2'}),
997 \ sign_getplaced(bnum2, {'group' : '*'})[0].signs)
998
999 " Test for :sign unplace * group=* buffer={nr}
1000 call Place_signs_for_test()
1001 exe 'sign unplace * group=* buffer=' . bnum2
1002 call assert_equal(signs1, sign_getplaced(bnum1, {'group' : '*'})[0].signs)
1003 call assert_equal([], sign_getplaced(bnum2, {'group' : '*'})[0].signs)
1004
1005 " Test for :sign unplace {id}
1006 call Place_signs_for_test()
1007 sign unplace 4
1008 sign unplace 6
1009 call assert_equal(
1010 \ filter(copy(signs1),
1011 \ {idx, val -> val.id != 4 || val.group != ''}),
1012 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1013 call assert_equal(
1014 \ filter(copy(signs2),
1015 \ {idx, val -> val.id != 6 || val.group != ''}),
1016 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1017
1018 " Test for :sign unplace {id} group={group}
1019 call Place_signs_for_test()
1020 sign unplace 4 group=g1
1021 sign unplace 6 group=g2
1022 call assert_equal(
1023 \ filter(copy(signs1),
1024 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1025 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1026 call assert_equal(
1027 \ filter(copy(signs2),
1028 \ {idx, val -> val.id != 6 || val.group != 'g2'}),
1029 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1030
1031 " Test for :sign unplace {id} group=*
1032 call Place_signs_for_test()
1033 sign unplace 3 group=*
1034 sign unplace 5 group=*
1035 call assert_equal(
1036 \ filter(copy(signs1),
1037 \ {idx, val -> val.id != 3}),
1038 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1039 call assert_equal(
1040 \ filter(copy(signs2),
1041 \ {idx, val -> val.id != 5}),
1042 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1043
1044 " Test for :sign unplace *
1045 call Place_signs_for_test()
1046 sign unplace *
1047 call assert_equal(
1048 \ filter(copy(signs1),
1049 \ {idx, val -> val.group != ''}),
1050 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1051 call assert_equal(
1052 \ filter(copy(signs2),
1053 \ {idx, val -> val.group != ''}),
1054 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1055
1056 " Test for :sign unplace * group={group}
1057 call Place_signs_for_test()
1058 sign unplace * group=g1
1059 call assert_equal(
1060 \ filter(copy(signs1),
1061 \ {idx, val -> val.group != 'g1'}),
1062 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1063 call assert_equal(
1064 \ filter(copy(signs2),
1065 \ {idx, val -> val.group != 'g1'}),
1066 \ sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1067
1068 " Test for :sign unplace * group=*
1069 call Place_signs_for_test()
1070 sign unplace * group=*
1071 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1072 call assert_equal([], sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1073
1074 " Negative test cases
1075 call Place_signs_for_test()
1076 sign unplace 3 group=xy file=Xsign1
1077 sign unplace * group=xy file=Xsign1
1078 silent! sign unplace * group=* file=FileNotPresent
1079 call assert_equal(signs1, sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1080 call assert_equal(signs2, sign_getplaced('Xsign2', {'group' : '*'})[0].signs)
1081
1082 " Tests for removing sign at the current cursor position
1083
1084 " Test for ':sign unplace'
1085 let signs1 = [{'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1086 \ 'priority' : 10},
1087 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1088 \ 'priority' : 10},
1089 \ {'id' : 4, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1090 \ 'priority' : 10},
1091 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g2',
1092 \ 'priority' : 10},
1093 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : 'g1',
1094 \ 'priority' : 10},
1095 \ {'id' : 3, 'name' : 'sign1', 'lnum' : 13, 'group' : '',
1096 \ 'priority' : 10},]
1097 exe bufwinnr('Xsign1') . 'wincmd w'
1098 call cursor(13, 1)
1099
1100 " Should remove only one sign in the global group
1101 call Place_signs_at_line_for_test()
1102 sign unplace
1103 call assert_equal(
1104 \ filter(copy(signs1),
1105 \ {idx, val -> val.id != 4 || val.group != ''}),
1106 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1107 " Should remove the second sign in the global group
1108 sign unplace
1109 call assert_equal(
1110 \ filter(copy(signs1),
1111 \ {idx, val -> val.group != ''}),
1112 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1113
1114 " Test for ':sign unplace group={group}'
1115 call Place_signs_at_line_for_test()
1116 " Should remove only one sign in group g1
1117 sign unplace group=g1
1118 call assert_equal(
1119 \ filter(copy(signs1),
1120 \ {idx, val -> val.id != 4 || val.group != 'g1'}),
1121 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1122 sign unplace group=g2
1123 call assert_equal(
1124 \ filter(copy(signs1),
1125 \ {idx, val -> val.id != 4 || val.group == ''}),
1126 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1127
1128 " Test for ':sign unplace group=*'
1129 call Place_signs_at_line_for_test()
1130 sign unplace group=*
1131 sign unplace group=*
1132 sign unplace group=*
1133 call assert_equal(
1134 \ filter(copy(signs1),
1135 \ {idx, val -> val.id != 4}),
1136 \ sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1137 sign unplace group=*
1138 sign unplace group=*
1139 sign unplace group=*
1140 call assert_equal([], sign_getplaced('Xsign1', {'group' : '*'})[0].signs)
1141
1142 call sign_unplace('*')
1143 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001144 enew | only
Bram Moolenaar7d83bf42018-12-29 18:53:55 +01001145 call delete("Xsign1")
1146 call delete("Xsign2")
1147endfunc
1148
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001149" Tests for auto-generating the sign identifier.
1150func Test_aaa_sign_id_autogen()
Bram Moolenaar162b7142018-12-21 15:17:36 +01001151 enew | only
1152 call sign_unplace('*')
1153 call sign_undefine()
1154
1155 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1156 call assert_equal(0, sign_define("sign1", attr))
1157
1158 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1159 edit Xsign
1160
1161 call assert_equal(1, sign_place(0, '', 'sign1', 'Xsign',
1162 \ {'lnum' : 10}))
1163 call assert_equal(2, sign_place(2, '', 'sign1', 'Xsign',
1164 \ {'lnum' : 12}))
1165 call assert_equal(3, sign_place(0, '', 'sign1', 'Xsign',
1166 \ {'lnum' : 14}))
1167 call sign_unplace('', {'buffer' : 'Xsign', 'id' : 2})
Bram Moolenaar6436cd82018-12-27 00:28:33 +01001168 call assert_equal(4, sign_place(0, '', 'sign1', 'Xsign',
Bram Moolenaar162b7142018-12-21 15:17:36 +01001169 \ {'lnum' : 12}))
1170
1171 call assert_equal(1, sign_place(0, 'g1', 'sign1', 'Xsign',
1172 \ {'lnum' : 11}))
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001173 " Check for the next generated sign id in this group
1174 call assert_equal(2, sign_place(0, 'g1', 'sign1', 'Xsign',
1175 \ {'lnum' : 12}))
Bram Moolenaar162b7142018-12-21 15:17:36 +01001176 call assert_equal(0, sign_unplace('g1', {'id' : 1}))
1177 call assert_equal(10,
1178 \ sign_getplaced('Xsign', {'id' : 1})[0].signs[0].lnum)
1179
1180 call delete("Xsign")
1181 call sign_unplace('*')
1182 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001183 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001184endfunc
1185
1186" Test for sign priority
1187func Test_sign_priority()
1188 enew | only
1189 call sign_unplace('*')
1190 call sign_undefine()
1191
1192 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Search'}
1193 call sign_define("sign1", attr)
1194 call sign_define("sign2", attr)
1195 call sign_define("sign3", attr)
1196
1197 " Place three signs with different priority in the same line
1198 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1199 edit Xsign
Bram Moolenaar162b7142018-12-21 15:17:36 +01001200
1201 call sign_place(1, 'g1', 'sign1', 'Xsign',
1202 \ {'lnum' : 11, 'priority' : 50})
1203 call sign_place(2, 'g2', 'sign2', 'Xsign',
1204 \ {'lnum' : 11, 'priority' : 100})
1205 call sign_place(3, '', 'sign3', 'Xsign', {'lnum' : 11})
1206 let s = sign_getplaced('Xsign', {'group' : '*'})
1207 call assert_equal([
1208 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11, 'group' : 'g2',
1209 \ 'priority' : 100},
1210 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : 'g1',
1211 \ 'priority' : 50},
1212 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11, 'group' : '',
1213 \ 'priority' : 10}],
1214 \ s[0].signs)
1215
Bram Moolenaar64416122019-06-07 21:37:13 +02001216 call sign_unplace('*')
1217
1218 " Three signs on different lines with changing priorities
1219 call sign_place(1, '', 'sign1', 'Xsign',
1220 \ {'lnum' : 11, 'priority' : 50})
1221 call sign_place(2, '', 'sign2', 'Xsign',
1222 \ {'lnum' : 12, 'priority' : 60})
1223 call sign_place(3, '', 'sign3', 'Xsign',
1224 \ {'lnum' : 13, 'priority' : 70})
1225 call sign_place(2, '', 'sign2', 'Xsign',
1226 \ {'lnum' : 12, 'priority' : 40})
1227 call sign_place(3, '', 'sign3', 'Xsign',
1228 \ {'lnum' : 13, 'priority' : 30})
1229 call sign_place(1, '', 'sign1', 'Xsign',
1230 \ {'lnum' : 11, 'priority' : 50})
1231 let s = sign_getplaced('Xsign', {'group' : '*'})
1232 call assert_equal([
1233 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11, 'group' : '',
1234 \ 'priority' : 50},
1235 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 12, 'group' : '',
1236 \ 'priority' : 40},
1237 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 13, 'group' : '',
1238 \ 'priority' : 30}],
1239 \ s[0].signs)
1240
1241 call sign_unplace('*')
1242
1243 " Two signs on the same line with changing priorities
1244 call sign_place(1, '', 'sign1', 'Xsign',
1245 \ {'lnum' : 4, 'priority' : 20})
1246 call sign_place(2, '', 'sign2', 'Xsign',
1247 \ {'lnum' : 4, 'priority' : 30})
1248 let s = sign_getplaced('Xsign', {'group' : '*'})
1249 call assert_equal([
1250 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1251 \ 'priority' : 30},
1252 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1253 \ 'priority' : 20}],
1254 \ s[0].signs)
1255 " Change the priority of the last sign to highest
1256 call sign_place(1, '', 'sign1', 'Xsign',
1257 \ {'lnum' : 4, 'priority' : 40})
1258 let s = sign_getplaced('Xsign', {'group' : '*'})
1259 call assert_equal([
1260 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1261 \ 'priority' : 40},
1262 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1263 \ 'priority' : 30}],
1264 \ s[0].signs)
1265 " Change the priority of the first sign to lowest
1266 call sign_place(1, '', 'sign1', 'Xsign',
1267 \ {'lnum' : 4, 'priority' : 25})
1268 let s = sign_getplaced('Xsign', {'group' : '*'})
1269 call assert_equal([
1270 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1271 \ 'priority' : 30},
1272 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1273 \ 'priority' : 25}],
1274 \ s[0].signs)
1275 call sign_place(1, '', 'sign1', 'Xsign',
1276 \ {'lnum' : 4, 'priority' : 45})
1277 call sign_place(2, '', 'sign2', 'Xsign',
1278 \ {'lnum' : 4, 'priority' : 55})
1279 let s = sign_getplaced('Xsign', {'group' : '*'})
1280 call assert_equal([
1281 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1282 \ 'priority' : 55},
1283 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1284 \ 'priority' : 45}],
1285 \ s[0].signs)
1286
1287 call sign_unplace('*')
1288
1289 " Three signs on the same line with changing priorities
1290 call sign_place(1, '', 'sign1', 'Xsign',
1291 \ {'lnum' : 4, 'priority' : 40})
1292 call sign_place(2, '', 'sign2', 'Xsign',
1293 \ {'lnum' : 4, 'priority' : 30})
1294 call sign_place(3, '', 'sign3', 'Xsign',
1295 \ {'lnum' : 4, 'priority' : 20})
1296 let s = sign_getplaced('Xsign', {'group' : '*'})
1297 call assert_equal([
1298 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1299 \ 'priority' : 40},
1300 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1301 \ 'priority' : 30},
1302 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1303 \ 'priority' : 20}],
1304 \ s[0].signs)
1305
1306 " Change the priority of the middle sign to the highest
1307 call sign_place(2, '', 'sign2', 'Xsign',
1308 \ {'lnum' : 4, 'priority' : 50})
1309 let s = sign_getplaced('Xsign', {'group' : '*'})
1310 call assert_equal([
1311 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1312 \ 'priority' : 50},
1313 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1314 \ 'priority' : 40},
1315 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1316 \ 'priority' : 20}],
1317 \ s[0].signs)
1318
1319 " Change the priority of the middle sign to the lowest
1320 call sign_place(1, '', 'sign1', 'Xsign',
1321 \ {'lnum' : 4, 'priority' : 15})
1322 let s = sign_getplaced('Xsign', {'group' : '*'})
1323 call assert_equal([
1324 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1325 \ 'priority' : 50},
1326 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1327 \ 'priority' : 20},
1328 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1329 \ 'priority' : 15}],
1330 \ s[0].signs)
1331
1332 " Change the priority of the last sign to the highest
1333 call sign_place(1, '', 'sign1', 'Xsign',
1334 \ {'lnum' : 4, 'priority' : 55})
1335 let s = sign_getplaced('Xsign', {'group' : '*'})
1336 call assert_equal([
1337 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1338 \ 'priority' : 55},
1339 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1340 \ 'priority' : 50},
1341 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1342 \ 'priority' : 20}],
1343 \ s[0].signs)
1344
1345 " Change the priority of the first sign to the lowest
1346 call sign_place(1, '', 'sign1', 'Xsign',
1347 \ {'lnum' : 4, 'priority' : 15})
1348 let s = sign_getplaced('Xsign', {'group' : '*'})
1349 call assert_equal([
1350 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1351 \ 'priority' : 50},
1352 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1353 \ 'priority' : 20},
1354 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1355 \ 'priority' : 15}],
1356 \ s[0].signs)
1357
1358 call sign_unplace('*')
1359
1360 " Three signs on the same line with changing priorities along with other
1361 " signs
1362 call sign_place(1, '', 'sign1', 'Xsign',
1363 \ {'lnum' : 2, 'priority' : 10})
1364 call sign_place(2, '', 'sign1', 'Xsign',
1365 \ {'lnum' : 4, 'priority' : 30})
1366 call sign_place(3, '', 'sign2', 'Xsign',
1367 \ {'lnum' : 4, 'priority' : 20})
1368 call sign_place(4, '', 'sign3', 'Xsign',
1369 \ {'lnum' : 4, 'priority' : 25})
1370 call sign_place(5, '', 'sign2', 'Xsign',
1371 \ {'lnum' : 6, 'priority' : 80})
1372 let s = sign_getplaced('Xsign', {'group' : '*'})
1373 call assert_equal([
1374 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1375 \ 'priority' : 10},
1376 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1377 \ 'priority' : 30},
1378 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1379 \ 'priority' : 25},
1380 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1381 \ 'priority' : 20},
1382 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1383 \ 'priority' : 80}],
1384 \ s[0].signs)
1385
1386 " Change the priority of the first sign to lowest
1387 call sign_place(2, '', 'sign1', 'Xsign',
1388 \ {'lnum' : 4, 'priority' : 15})
1389 let s = sign_getplaced('Xsign', {'group' : '*'})
1390 call assert_equal([
1391 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1392 \ 'priority' : 10},
1393 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1394 \ 'priority' : 25},
1395 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1396 \ 'priority' : 20},
1397 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1398 \ 'priority' : 15},
1399 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1400 \ 'priority' : 80}],
1401 \ s[0].signs)
1402
1403 " Change the priority of the last sign to highest
1404 call sign_place(2, '', 'sign1', 'Xsign',
1405 \ {'lnum' : 4, 'priority' : 30})
1406 let s = sign_getplaced('Xsign', {'group' : '*'})
1407 call assert_equal([
1408 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1409 \ 'priority' : 10},
1410 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1411 \ 'priority' : 30},
1412 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1413 \ 'priority' : 25},
1414 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1415 \ 'priority' : 20},
1416 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1417 \ 'priority' : 80}],
1418 \ s[0].signs)
1419
1420 " Change the priority of the middle sign to lowest
1421 call sign_place(4, '', 'sign3', 'Xsign',
1422 \ {'lnum' : 4, 'priority' : 15})
1423 let s = sign_getplaced('Xsign', {'group' : '*'})
1424 call assert_equal([
1425 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1426 \ 'priority' : 10},
1427 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1428 \ 'priority' : 30},
1429 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1430 \ 'priority' : 20},
1431 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1432 \ 'priority' : 15},
1433 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1434 \ 'priority' : 80}],
1435 \ s[0].signs)
1436
1437 " Change the priority of the middle sign to highest
1438 call sign_place(3, '', 'sign2', 'Xsign',
1439 \ {'lnum' : 4, 'priority' : 35})
1440 let s = sign_getplaced('Xsign', {'group' : '*'})
1441 call assert_equal([
1442 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 2, 'group' : '',
1443 \ 'priority' : 10},
1444 \ {'id' : 3, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1445 \ 'priority' : 35},
1446 \ {'id' : 2, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1447 \ 'priority' : 30},
1448 \ {'id' : 4, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1449 \ 'priority' : 15},
1450 \ {'id' : 5, 'name' : 'sign2', 'lnum' : 6, 'group' : '',
1451 \ 'priority' : 80}],
1452 \ s[0].signs)
1453
1454 call sign_unplace('*')
1455
1456 " Multiple signs with the same priority on the same line
1457 call sign_place(1, '', 'sign1', 'Xsign',
1458 \ {'lnum' : 4, 'priority' : 20})
1459 call sign_place(2, '', 'sign2', 'Xsign',
1460 \ {'lnum' : 4, 'priority' : 20})
1461 call sign_place(3, '', 'sign3', 'Xsign',
1462 \ {'lnum' : 4, 'priority' : 20})
1463 let s = sign_getplaced('Xsign', {'group' : '*'})
1464 call assert_equal([
1465 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1466 \ 'priority' : 20},
1467 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1468 \ 'priority' : 20},
1469 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1470 \ 'priority' : 20}],
1471 \ s[0].signs)
1472 " Place the last sign again with the same priority
1473 call sign_place(1, '', 'sign1', 'Xsign',
1474 \ {'lnum' : 4, 'priority' : 20})
1475 let s = sign_getplaced('Xsign', {'group' : '*'})
1476 call assert_equal([
1477 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1478 \ 'priority' : 20},
1479 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1480 \ 'priority' : 20},
1481 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1482 \ 'priority' : 20}],
1483 \ s[0].signs)
1484 " Place the first sign again with the same priority
1485 call sign_place(1, '', 'sign1', 'Xsign',
1486 \ {'lnum' : 4, 'priority' : 20})
1487 let s = sign_getplaced('Xsign', {'group' : '*'})
1488 call assert_equal([
1489 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1490 \ 'priority' : 20},
1491 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1492 \ 'priority' : 20},
1493 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1494 \ 'priority' : 20}],
1495 \ s[0].signs)
1496 " Place the middle sign again with the same priority
1497 call sign_place(3, '', 'sign3', 'Xsign',
1498 \ {'lnum' : 4, 'priority' : 20})
1499 let s = sign_getplaced('Xsign', {'group' : '*'})
1500 call assert_equal([
1501 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 4, 'group' : '',
1502 \ 'priority' : 20},
1503 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 4, 'group' : '',
1504 \ 'priority' : 20},
1505 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 4, 'group' : '',
1506 \ 'priority' : 20}],
1507 \ s[0].signs)
1508
1509 call sign_unplace('*')
1510
Bram Moolenaar58a7f872019-06-04 22:48:15 +02001511 " Place multiple signs with same id on a line with different priority
1512 call sign_place(1, '', 'sign1', 'Xsign',
1513 \ {'lnum' : 5, 'priority' : 20})
1514 call sign_place(1, '', 'sign2', 'Xsign',
1515 \ {'lnum' : 5, 'priority' : 10})
1516 let s = sign_getplaced('Xsign', {'lnum' : 5})
1517 call assert_equal([
1518 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1519 \ 'priority' : 10}],
1520 \ s[0].signs)
1521 call sign_place(1, '', 'sign2', 'Xsign',
1522 \ {'lnum' : 5, 'priority' : 5})
1523 let s = sign_getplaced('Xsign', {'lnum' : 5})
1524 call assert_equal([
1525 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 5, 'group' : '',
1526 \ 'priority' : 5}],
1527 \ s[0].signs)
1528
Bram Moolenaar162b7142018-12-21 15:17:36 +01001529 " Error case
1530 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1531 \ [])", 'E715:')
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001532 call assert_fails("call sign_place(1, 'g1', 'sign1', 'Xsign',
1533 \ {'priority' : []})", 'E745:')
Bram Moolenaar162b7142018-12-21 15:17:36 +01001534 call sign_unplace('*')
1535
1536 " Tests for the :sign place command with priority
1537 sign place 5 line=10 name=sign1 priority=30 file=Xsign
1538 sign place 5 group=g1 line=10 name=sign1 priority=20 file=Xsign
1539 sign place 5 group=g2 line=10 name=sign1 priority=25 file=Xsign
1540 let a = execute('sign place group=*')
1541 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001542 \ " line=10 id=5 name=sign1 priority=30\n" .
1543 \ " line=10 id=5 group=g2 name=sign1 priority=25\n" .
1544 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001545
1546 " Test for :sign place group={group}
1547 let a = execute('sign place group=g1')
1548 call assert_equal("\n--- Signs ---\nSigns for Xsign:\n" .
Bram Moolenaard730c8e2019-01-07 21:16:53 +01001549 \ " line=10 id=5 group=g1 name=sign1 priority=20\n", a)
Bram Moolenaar162b7142018-12-21 15:17:36 +01001550
1551 call sign_unplace('*')
1552 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001553 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001554 call delete("Xsign")
1555endfunc
1556
1557" Tests for memory allocation failures in sign functions
1558func Test_sign_memfailures()
1559 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1560 edit Xsign
1561
1562 call test_alloc_fail(GetAllocId('sign_getdefined'), 0, 0)
1563 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1564 call test_alloc_fail(GetAllocId('sign_getplaced'), 0, 0)
1565 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1566 call test_alloc_fail(GetAllocId('sign_define_by_name'), 0, 0)
1567 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1568 call assert_fails('call sign_define("sign1", attr)', 'E342:')
1569
1570 let attr = {'text' : '=>', 'linehl' : 'Search', 'texthl' : 'Error'}
1571 call sign_define("sign1", attr)
1572 call test_alloc_fail(GetAllocId('sign_getlist'), 0, 0)
1573 call assert_fails('call sign_getdefined("sign1")', 'E342:')
1574
1575 call sign_place(3, 'g1', 'sign1', 'Xsign', {'lnum' : 10})
1576 call test_alloc_fail(GetAllocId('sign_getplaced_dict'), 0, 0)
1577 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1578 call test_alloc_fail(GetAllocId('sign_getplaced_list'), 0, 0)
1579 call assert_fails('call sign_getplaced("Xsign")', 'E342:')
1580
1581 call test_alloc_fail(GetAllocId('insert_sign'), 0, 0)
1582 call assert_fails('call sign_place(4, "g1", "sign1", "Xsign", {"lnum" : 11})',
1583 \ 'E342:')
1584
1585 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1586 call assert_fails('call getbufinfo()', 'E342:')
1587 call sign_place(4, 'g1', 'sign1', 'Xsign', {'lnum' : 11})
1588 call test_alloc_fail(GetAllocId('sign_getinfo'), 0, 0)
1589 call assert_fails('let binfo=getbufinfo("Xsign")', 'E342:')
1590 call assert_equal([{'lnum': 11, 'id': 4, 'name': 'sign1',
1591 \ 'priority': 10, 'group': 'g1'}], binfo[0].signs)
1592
1593 call sign_unplace('*')
1594 call sign_undefine()
Bram Moolenaar1ea88a32018-12-29 21:00:27 +01001595 enew | only
Bram Moolenaar162b7142018-12-21 15:17:36 +01001596 call delete("Xsign")
1597endfunc
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001598
1599" Test for auto-adjusting the line number of a placed sign.
1600func Test_sign_lnum_adjust()
1601 enew! | only!
1602
1603 sign define sign1 text=#> linehl=Comment
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001604 call setline(1, ['A', 'B', 'C', 'D', 'E'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001605 exe 'sign place 5 line=3 name=sign1 buffer=' . bufnr('')
1606 let l = sign_getplaced(bufnr(''))
1607 call assert_equal(3, l[0].signs[0].lnum)
1608
1609 " Add some lines before the sign and check the sign line number
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001610 call append(2, ['BA', 'BB', 'BC'])
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001611 let l = sign_getplaced(bufnr(''))
1612 call assert_equal(6, l[0].signs[0].lnum)
1613
1614 " Delete some lines before the sign and check the sign line number
1615 call deletebufline('%', 1, 2)
1616 let l = sign_getplaced(bufnr(''))
1617 call assert_equal(4, l[0].signs[0].lnum)
1618
Bram Moolenaarc771bf92019-01-17 17:36:45 +01001619 " Insert some lines after the sign and check the sign line number
1620 call append(5, ['DA', 'DB'])
1621 let l = sign_getplaced(bufnr(''))
1622 call assert_equal(4, l[0].signs[0].lnum)
1623
1624 " Delete some lines after the sign and check the sign line number
1625 call deletebufline('', 6, 7)
1626 let l = sign_getplaced(bufnr(''))
1627 call assert_equal(4, l[0].signs[0].lnum)
1628
1629 " Break the undo. Otherwise the undo operation below will undo all the
1630 " changes made by this function.
1631 let &undolevels=&undolevels
1632
1633 " Delete the line with the sign
1634 call deletebufline('', 4)
1635 let l = sign_getplaced(bufnr(''))
1636 call assert_equal(4, l[0].signs[0].lnum)
1637
1638 " Undo the delete operation
1639 undo
1640 let l = sign_getplaced(bufnr(''))
1641 call assert_equal(5, l[0].signs[0].lnum)
1642
1643 " Break the undo
1644 let &undolevels=&undolevels
1645
1646 " Delete few lines at the end of the buffer including the line with the sign
1647 " Sign line number should not change (as it is placed outside of the buffer)
1648 call deletebufline('', 3, 6)
1649 let l = sign_getplaced(bufnr(''))
1650 call assert_equal(5, l[0].signs[0].lnum)
1651
1652 " Undo the delete operation. Sign should be restored to the previous line
1653 undo
1654 let l = sign_getplaced(bufnr(''))
1655 call assert_equal(5, l[0].signs[0].lnum)
1656
Bram Moolenaar2cbc1a02019-01-02 13:40:31 +01001657 sign unplace * group=*
1658 sign undefine sign1
1659 enew!
1660endfunc
1661
1662" Test for changing the type of a placed sign
1663func Test_sign_change_type()
1664 enew! | only!
1665
1666 sign define sign1 text=#> linehl=Comment
1667 sign define sign2 text=@@ linehl=Comment
1668
1669 call setline(1, ['A', 'B', 'C', 'D'])
1670 exe 'sign place 4 line=3 name=sign1 buffer=' . bufnr('')
1671 let l = sign_getplaced(bufnr(''))
1672 call assert_equal('sign1', l[0].signs[0].name)
1673 exe 'sign place 4 name=sign2 buffer=' . bufnr('')
1674 let l = sign_getplaced(bufnr(''))
1675 call assert_equal('sign2', l[0].signs[0].name)
1676 call sign_place(4, '', 'sign1', '')
1677 let l = sign_getplaced(bufnr(''))
1678 call assert_equal('sign1', l[0].signs[0].name)
1679
1680 exe 'sign place 4 group=g1 line=4 name=sign1 buffer=' . bufnr('')
1681 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1682 call assert_equal('sign1', l[0].signs[0].name)
1683 exe 'sign place 4 group=g1 name=sign2 buffer=' . bufnr('')
1684 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1685 call assert_equal('sign2', l[0].signs[0].name)
1686 call sign_place(4, 'g1', 'sign1', '')
1687 let l = sign_getplaced(bufnr(''), {'group' : 'g1'})
1688 call assert_equal('sign1', l[0].signs[0].name)
1689
1690 sign unplace * group=*
1691 sign undefine sign1
1692 sign undefine sign2
1693 enew!
1694endfunc
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001695
1696" Test for the sign_jump() function
1697func Test_sign_jump_func()
1698 enew! | only!
1699
1700 sign define sign1 text=#> linehl=Comment
1701
1702 edit foo
1703 set buftype=nofile
1704 call setline(1, ['A', 'B', 'C', 'D', 'E'])
1705 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1706 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1707 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1708 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1709 split bar
1710 set buftype=nofile
1711 call setline(1, ['P', 'Q', 'R', 'S', 'T'])
1712 call sign_place(5, '', 'sign1', '', {'lnum' : 2})
1713 call sign_place(5, 'g1', 'sign1', '', {'lnum' : 3})
1714 call sign_place(6, '', 'sign1', '', {'lnum' : 4})
1715 call sign_place(6, 'g1', 'sign1', '', {'lnum' : 5})
1716
1717 let r = sign_jump(5, '', 'foo')
1718 call assert_equal(2, r)
1719 call assert_equal(2, line('.'))
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001720 let r = 6->sign_jump('g1', 'foo')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001721 call assert_equal(5, r)
1722 call assert_equal(5, line('.'))
1723 let r = sign_jump(5, '', 'bar')
1724 call assert_equal(2, r)
1725 call assert_equal(2, line('.'))
1726
1727 " Error cases
1728 call assert_fails("call sign_jump(99, '', 'bar')", 'E157:')
1729 call assert_fails("call sign_jump(0, '', 'foo')", 'E474:')
1730 call assert_fails("call sign_jump(5, 'g5', 'foo')", 'E157:')
1731 call assert_fails('call sign_jump([], "", "foo")', 'E745:')
1732 call assert_fails('call sign_jump(2, [], "foo")', 'E730:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001733 call assert_fails('call sign_jump(2, "", {})', 'E731:')
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01001734 call assert_fails('call sign_jump(2, "", "baz")', 'E158:')
1735
1736 sign unplace * group=*
1737 sign undefine sign1
1738 enew! | only!
1739endfunc
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001740
1741" Test for correct cursor position after the sign column appears or disappears.
1742func Test_sign_cursor_position()
Bram Moolenaar494e9062020-05-31 21:28:02 +02001743 CheckRunVimInTerminal
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001744
1745 let lines =<< trim END
1746 call setline(1, [repeat('x', 75), 'mmmm', 'yyyy'])
1747 call cursor(2,1)
1748 sign define s1 texthl=Search text==>
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001749 sign define s2 linehl=Pmenu
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001750 redraw
1751 sign place 10 line=2 name=s1
1752 END
1753 call writefile(lines, 'XtestSigncolumn')
1754 let buf = RunVimInTerminal('-S XtestSigncolumn', {'rows': 6})
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001755 call VerifyScreenDump(buf, 'Test_sign_cursor_1', {})
1756
1757 " Change the sign text
1758 call term_sendkeys(buf, ":sign define s1 text=-)\<CR>")
1759 call VerifyScreenDump(buf, 'Test_sign_cursor_2', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001760
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001761 " Also place a line HL sign
1762 call term_sendkeys(buf, ":sign place 11 line=2 name=s2\<CR>")
Bram Moolenaarbf0acff2020-01-09 21:01:59 +01001763 call VerifyScreenDump(buf, 'Test_sign_cursor_3', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001764
Bram Moolenaara2f6e422020-02-19 17:13:04 +01001765 " update cursor position calculation
1766 call term_sendkeys(buf, "lh")
1767 call term_sendkeys(buf, ":sign unplace 11\<CR>")
1768 call term_sendkeys(buf, ":sign unplace 10\<CR>")
1769 call VerifyScreenDump(buf, 'Test_sign_cursor_4', {})
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001770
Bram Moolenaar39f7aa32020-08-31 22:00:05 +02001771 " 'cursorline' highlighting overrules sign
1772 call term_sendkeys(buf, ":sign place 12 line=2 name=s2\<CR>")
1773 call term_sendkeys(buf, ":set cursorline\<CR>")
1774 call term_sendkeys(buf, ":hi CursorLine ctermbg=Green\<CR>")
1775 call term_sendkeys(buf, "2G")
1776 call term_sendkeys(buf, ":\<CR>")
1777 call VerifyScreenDump(buf, 'Test_sign_cursor_5', {})
1778
1779 " sign highlighting overrules 'cursorline'
1780 call term_sendkeys(buf, ":sign unplace 12\<CR>")
1781 call term_sendkeys(buf, ":sign place 13 line=2 priority=100 name=s2\<CR>")
1782 call term_sendkeys(buf, ":\<CR>")
1783 call VerifyScreenDump(buf, 'Test_sign_cursor_6', {})
1784
Bram Moolenaarf85e40a2019-06-16 13:55:40 +02001785 " clean up
1786 call StopVimInTerminal(buf)
1787 call delete('XtestSigncolumn')
1788endfunc
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001789
1790" Return the 'len' characters in screen starting from (row,col)
1791func s:ScreenLine(row, col, len)
1792 let s = ''
1793 for i in range(a:len)
1794 let s .= nr2char(screenchar(a:row, a:col + i))
1795 endfor
1796 return s
1797endfunc
1798
1799" Test for 'signcolumn' set to 'number'.
1800func Test_sign_numcol()
1801 new
1802 call append(0, "01234")
1803 " With 'signcolumn' set to 'number', make sure sign is displayed in the
1804 " number column and line number is not displayed.
1805 set numberwidth=2
1806 set number
1807 set signcolumn=number
1808 sign define sign1 text==>
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001809 sign define sign2 text=V
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001810 sign place 10 line=1 name=sign1
1811 redraw!
1812 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1813
1814 " With 'signcolumn' set to 'number', when there is no sign, make sure line
1815 " number is displayed in the number column
1816 sign unplace 10
1817 redraw!
1818 call assert_equal("1 01234", s:ScreenLine(1, 1, 7))
1819
1820 " Disable number column. Check whether sign is displayed in the sign column
1821 set numberwidth=4
1822 set nonumber
1823 sign place 10 line=1 name=sign1
1824 redraw!
1825 call assert_equal("=>01234", s:ScreenLine(1, 1, 7))
1826
1827 " Enable number column. Check whether sign is displayed in the number column
1828 set number
1829 redraw!
Bram Moolenaar4dff4ae2019-06-19 16:31:28 +02001830 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001831
1832 " Disable sign column. Make sure line number is displayed
1833 set signcolumn=no
1834 redraw!
1835 call assert_equal(" 1 01234", s:ScreenLine(1, 1, 9))
1836
1837 " Enable auto sign column. Make sure both sign and line number are displayed
1838 set signcolumn=auto
1839 redraw!
1840 call assert_equal("=> 1 01234", s:ScreenLine(1, 1, 11))
1841
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001842 " Test displaying signs in the number column with width 1
1843 call sign_unplace('*')
1844 call append(1, "abcde")
1845 call append(2, "01234")
1846 " Enable number column with width 1
1847 set number numberwidth=1 signcolumn=auto
1848 redraw!
1849 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1850 " Place a sign and make sure number column width remains the same
1851 sign place 20 line=2 name=sign1
1852 redraw!
1853 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1854 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1855 " Set 'signcolumn' to 'number', make sure the number column width increases
1856 set signcolumn=number
1857 redraw!
1858 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1859 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1860 " Set 'signcolumn' to 'auto', make sure the number column width is 1.
1861 set signcolumn=auto
1862 redraw!
1863 call assert_equal("=>2 abcde", s:ScreenLine(2, 1, 9))
1864 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 9))
1865 " Set 'signcolumn' to 'number', make sure the number column width is 2.
1866 set signcolumn=number
1867 redraw!
1868 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1869 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1870 " Disable 'number' column
1871 set nonumber
1872 redraw!
1873 call assert_equal("=>abcde", s:ScreenLine(2, 1, 7))
1874 call assert_equal(" 01234", s:ScreenLine(3, 1, 7))
1875 " Enable 'number' column
1876 set number
1877 redraw!
1878 call assert_equal("=> abcde", s:ScreenLine(2, 1, 8))
1879 call assert_equal(" 3 01234", s:ScreenLine(3, 1, 8))
1880 " Remove the sign and make sure the width of the number column is 1.
1881 call sign_unplace('', {'id' : 20})
1882 redraw!
1883 call assert_equal("3 01234", s:ScreenLine(3, 1, 7))
1884 " When the first sign is placed with 'signcolumn' set to number, verify that
1885 " the number column width increases
1886 sign place 30 line=1 name=sign1
1887 redraw!
1888 call assert_equal("=> 01234", s:ScreenLine(1, 1, 8))
1889 call assert_equal(" 2 abcde", s:ScreenLine(2, 1, 8))
Bram Moolenaard6bcff42019-07-18 12:48:16 +02001890 " Add sign with multi-byte text
1891 set numberwidth=4
1892 sign place 40 line=2 name=sign2
1893 redraw!
1894 call assert_equal(" => 01234", s:ScreenLine(1, 1, 9))
1895 call assert_equal(" V abcde", s:ScreenLine(2, 1, 9))
Bram Moolenaare4b407f2019-07-04 11:59:28 +02001896
1897 sign unplace * group=*
Bram Moolenaar394c5d82019-06-17 21:48:05 +02001898 sign undefine sign1
1899 set signcolumn&
1900 set number&
1901 enew! | close
1902endfunc
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001903
1904" Test for managing multiple signs using the sign functions
1905func Test_sign_funcs_multi()
1906 call writefile(repeat(["Sun is shining"], 30), "Xsign")
1907 edit Xsign
1908 let bnum = bufnr('')
1909
1910 " Define multiple signs at once
1911 call assert_equal([0, 0, 0, 0], sign_define([
1912 \ {'name' : 'sign1', 'text' : '=>', 'linehl' : 'Search',
1913 \ 'texthl' : 'Search'},
1914 \ {'name' : 'sign2', 'text' : '=>', 'linehl' : 'Search',
1915 \ 'texthl' : 'Search'},
1916 \ {'name' : 'sign3', 'text' : '=>', 'linehl' : 'Search',
1917 \ 'texthl' : 'Search'},
1918 \ {'name' : 'sign4', 'text' : '=>', 'linehl' : 'Search',
1919 \ 'texthl' : 'Search'}]))
1920
1921 " Negative cases for sign_define()
1922 call assert_equal([], sign_define([]))
1923 call assert_equal([-1], sign_define([{}]))
1924 call assert_fails('call sign_define([6])', 'E715:')
1925 call assert_fails('call sign_define(["abc"])', 'E715:')
1926 call assert_fails('call sign_define([[]])', 'E715:')
1927
1928 " Place multiple signs at once with specific sign identifier
1929 let l = sign_placelist([{'id' : 1, 'group' : 'g1', 'name' : 'sign1',
1930 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 50},
1931 \ {'id' : 2, 'group' : 'g2', 'name' : 'sign2',
1932 \ 'buffer' : 'Xsign', 'lnum' : 11, 'priority' : 100},
1933 \ {'id' : 3, 'group' : '', 'name' : 'sign3',
1934 \ 'buffer' : 'Xsign', 'lnum' : 11}])
1935 call assert_equal([1, 2, 3], l)
1936 let s = sign_getplaced('Xsign', {'group' : '*'})
1937 call assert_equal([
1938 \ {'id' : 2, 'name' : 'sign2', 'lnum' : 11,
1939 \ 'group' : 'g2', 'priority' : 100},
1940 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1941 \ 'group' : 'g1', 'priority' : 50},
1942 \ {'id' : 3, 'name' : 'sign3', 'lnum' : 11,
1943 \ 'group' : '', 'priority' : 10}], s[0].signs)
1944
1945 call sign_unplace('*')
1946
1947 " Place multiple signs at once with auto-generated sign identifier
1948 call assert_equal([1, 1, 5], sign_placelist([
1949 \ {'group' : 'g1', 'name' : 'sign1',
1950 \ 'buffer' : 'Xsign', 'lnum' : 11},
1951 \ {'group' : 'g2', 'name' : 'sign2',
1952 \ 'buffer' : 'Xsign', 'lnum' : 11},
1953 \ {'group' : '', 'name' : 'sign3',
1954 \ 'buffer' : 'Xsign', 'lnum' : 11}]))
1955 let s = sign_getplaced('Xsign', {'group' : '*'})
1956 call assert_equal([
1957 \ {'id' : 5, 'name' : 'sign3', 'lnum' : 11,
1958 \ 'group' : '', 'priority' : 10},
1959 \ {'id' : 1, 'name' : 'sign2', 'lnum' : 11,
1960 \ 'group' : 'g2', 'priority' : 10},
1961 \ {'id' : 1, 'name' : 'sign1', 'lnum' : 11,
1962 \ 'group' : 'g1', 'priority' : 10}], s[0].signs)
1963
1964 " Change an existing sign without specifying the group
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001965 call assert_equal([5], [{'id' : 5, 'name' : 'sign1', 'buffer' : 'Xsign'}]->sign_placelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001966 let s = sign_getplaced('Xsign', {'id' : 5, 'group' : ''})
1967 call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
1968 \ 'group' : '', 'priority' : 10}], s[0].signs)
1969
Bram Moolenaar42aff462019-08-21 13:20:29 +02001970 " Place a sign using '.' as the line number
1971 call cursor(23, 1)
1972 call assert_equal([7], sign_placelist([
1973 \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
1974 let s = sign_getplaced('%', {'lnum' : '.'})
1975 call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
1976 \ 'group' : '', 'priority' : 10}], s[0].signs)
1977
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001978 " Place sign without a sign name
1979 call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
1980 \ 'lnum' : 12, 'group' : ''}]))
1981
1982 " Place sign without a buffer
1983 call assert_equal([-1], sign_placelist([{'id' : 10, 'name' : 'sign1',
1984 \ 'lnum' : 12, 'group' : ''}]))
1985
1986 " Invalid arguments
1987 call assert_equal([], sign_placelist([]))
1988 call assert_fails('call sign_placelist({})', "E714:")
1989 call assert_fails('call sign_placelist([[]])', "E715:")
1990 call assert_fails('call sign_placelist(["abc"])', "E715:")
1991 call assert_fails('call sign_placelist([100])', "E715:")
1992
1993 " Unplace multiple signs
1994 call assert_equal([0, 0, 0], sign_unplacelist([{'id' : 5},
1995 \ {'id' : 1, 'group' : 'g1'}, {'id' : 1, 'group' : 'g2'}]))
1996
1997 " Invalid arguments
Bram Moolenaar93476fd2019-09-06 22:00:54 +02001998 call assert_equal([], []->sign_unplacelist())
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02001999 call assert_fails('call sign_unplacelist({})', "E714:")
2000 call assert_fails('call sign_unplacelist([[]])', "E715:")
2001 call assert_fails('call sign_unplacelist(["abc"])', "E715:")
2002 call assert_fails('call sign_unplacelist([100])', "E715:")
Bram Moolenaare2e40752020-09-04 21:18:46 +02002003 call assert_fails("call sign_unplacelist([{'id' : -1}])", 'E474:')
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002004
2005 call assert_equal([0, 0, 0, 0],
2006 \ sign_undefine(['sign1', 'sign2', 'sign3', 'sign4']))
2007 call assert_equal([], sign_getdefined())
2008
2009 " Invalid arguments
2010 call assert_equal([], sign_undefine([]))
2011 call assert_fails('call sign_undefine([[]])', 'E730:')
2012 call assert_fails('call sign_undefine([{}])', 'E731:')
2013 call assert_fails('call sign_undefine(["1abc2"])', 'E155:')
2014
2015 call sign_unplace('*')
2016 call sign_undefine()
2017 enew!
2018 call delete("Xsign")
2019endfunc
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002020
Bram Moolenaar5c56da42021-08-28 14:42:25 +02002021func Test_sign_null_list()
2022 eval test_null_list()->sign_define()
2023 eval test_null_list()->sign_placelist()
2024 eval test_null_list()->sign_undefine()
2025 eval test_null_list()->sign_unplacelist()
2026endfunc
2027
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +02002028" vim: shiftwidth=2 sts=2 expandtab