blob: 679099cfc30406398637c6d018f20d02f615d7d3 [file] [log] [blame]
zeertzjqfc3f5db2024-07-07 20:33:46 +02001*sign.txt* For Vim version 9.1. Last change: 2024 Jul 07
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Gordon Prieur
5 and Bram Moolenaar
6
7
8Sign Support Features *sign-support*
9
101. Introduction |sign-intro|
112. Commands |sign-commands|
Bram Moolenaared997ad2019-07-21 16:42:00 +0200123. Functions |sign-functions-details|
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
Bram Moolenaar071d4272004-06-13 20:20:40 +000014{only available when compiled with the |+signs| feature}
15
16==============================================================================
171. Introduction *sign-intro* *signs*
18
19When a debugger or other IDE tool is driving an editor it needs to be able
20to give specific highlights which quickly tell the user useful information
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000021about the file. One example of this would be a debugger which had an icon
22in the left-hand column denoting a breakpoint. Another example might be an
23arrow representing the Program Counter (PC). The sign features allow both
Bram Moolenaar071d4272004-06-13 20:20:40 +000024placement of a sign, or icon, in the left-hand side of the window and
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000025definition of a highlight which will be applied to that line. Displaying the
Bram Moolenaar071d4272004-06-13 20:20:40 +000026sign as an image is most likely only feasible in gvim (although Sun
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000027Microsystem's dtterm does support this it's the only terminal emulator I know
Bram Moolenaar071d4272004-06-13 20:20:40 +000028of which does). A text sign and the highlight should be feasible in any color
29terminal emulator.
30
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000031Signs and highlights are not useful just for debuggers. Sun's Visual
Bram Moolenaar071d4272004-06-13 20:20:40 +000032WorkShop uses signs and highlights to mark build errors and SourceBrowser
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000033hits. Additionally, the debugger supports 8 to 10 different signs and
Bram Moolenaard09091d2019-01-17 16:07:22 +010034highlight colors, see |NetBeans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000035
36There are two steps in using signs:
37
381. Define the sign. This specifies the image, text and highlighting. For
39 example, you can define a "break" sign with an image of a stop roadsign and
40 text "!!".
41
422. Place the sign. This specifies the file and line number where the sign is
43 displayed. A defined sign can be placed several times in different lines
44 and files.
45
Bram Moolenaard09091d2019-01-17 16:07:22 +010046 *sign-column*
Bram Moolenaar071d4272004-06-13 20:20:40 +000047When signs are defined for a file, Vim will automatically add a column of two
48characters to display them in. When the last sign is unplaced the column
Bram Moolenaar09521312016-08-12 22:54:35 +020049disappears again. This behavior can be changed with the 'signcolumn' option.
50
Bram Moolenaar574ee7b2019-11-13 23:04:29 +010051The color of the column is set with the SignColumn highlight group
52|hl-SignColumn|. Example to set the color: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000053
54 :highlight SignColumn guibg=darkgrey
Bram Moolenaar162b7142018-12-21 15:17:36 +010055<
Bram Moolenaare413ea02021-11-24 16:20:13 +000056If 'cursorline' is enabled, then the CursorLineSign highlight group is used
57|hl-CursorLineSign|.
Bram Moolenaarb328cca2019-01-06 16:24:01 +010058 *sign-identifier*
59Each placed sign is identified by a number called the sign identifier. This
60identifier is used to jump to the sign or to remove the sign. The identifier
Bram Moolenaard09091d2019-01-17 16:07:22 +010061is assigned when placing the sign using the |:sign-place| command or the
Bram Moolenaarb328cca2019-01-06 16:24:01 +010062|sign_place()| function. Each sign identifier should be a unique number. If
63multiple placed signs use the same identifier, then jumping to or removing a
64sign becomes unpredictable. To avoid overlapping identifiers, sign groups can
65be used. The |sign_place()| function can be called with a zero sign identifier
66to allocate the next available identifier.
67
Bram Moolenaar162b7142018-12-21 15:17:36 +010068 *sign-group*
Bram Moolenaarb328cca2019-01-06 16:24:01 +010069Each placed sign can be assigned to either the global group or a named group.
70When placing a sign, if a group name is not supplied, or an empty string is
71used, then the sign is placed in the global group. Otherwise the sign is
72placed in the named group. The sign identifier is unique within a group. The
73sign group allows Vim plugins to use unique signs without interfering with
74other plugins using signs.
Bram Moolenaar162b7142018-12-21 15:17:36 +010075
Bram Moolenaar72570732019-11-30 14:21:53 +010076To place a sign in a popup window the group name must start with "PopUp".
77Other signs will not show in a popup window. The group name "PopUpMenu" is
78used by popup windows where 'cursorline' is set.
79
Bram Moolenaar162b7142018-12-21 15:17:36 +010080 *sign-priority*
81Each placed sign is assigned a priority value. When multiple signs are placed
82on the same line, the attributes of the sign with the highest priority is used
LemonBoyb975ddf2024-07-06 18:04:09 +020083independently of the sign group. The default priority for a sign is 10, this
84value can be changed for different signs by specifying a different value at
85definition time. The priority is assigned at the time of placing a sign.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086
Bram Moolenaar3132cdd2020-11-05 20:41:49 +010087When two signs with the same priority are present, and one has an icon or text
88in the signcolumn while the other has line highlighting, then both are
89displayed.
90
Bram Moolenaard09091d2019-01-17 16:07:22 +010091When the line on which the sign is placed is deleted, the sign is moved to the
92next line (or the last line of the buffer, if there is no next line). When
93the delete is undone the sign does not move back.
94
Bram Moolenaar39f7aa32020-08-31 22:00:05 +020095When a sign with line highlighting and 'cursorline' highlighting are both
96present, if the priority is 100 or more then the sign highlighting takes
97precedence, otherwise the 'cursorline' highlighting.
98
Bram Moolenaar071d4272004-06-13 20:20:40 +000099==============================================================================
1002. Commands *sign-commands* *:sig* *:sign*
101
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200102Here is an example that places a sign "piet", displayed with the text ">>", in
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103line 23 of the current file: >
104 :sign define piet text=>> texthl=Search
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000105 :exe ":sign place 2 line=23 name=piet file=" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106
107And here is the command to delete it again: >
108 :sign unplace 2
109
110Note that the ":sign" command cannot be followed by another command or a
111comment. If you do need that, use the |:execute| command.
112
113
114DEFINING A SIGN. *:sign-define* *E255* *E160* *E612*
115
Bram Moolenaar162b7142018-12-21 15:17:36 +0100116See |sign_define()| for the equivalent Vim script function.
117
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118:sign define {name} {argument}...
119 Define a new sign or set attributes for an existing sign.
120 The {name} can either be a number (all digits) or a name
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100121 starting with a non-digit. Leading zeros are ignored, thus
Bram Moolenaar483c5d82010-10-20 18:45:33 +0200122 "0012", "012" and "12" are considered the same name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 About 120 different signs can be defined.
124
125 Accepted arguments:
126
Bram Moolenaar6ee8d892012-01-10 14:55:01 +0100127 icon={bitmap}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 Define the file name where the bitmap can be found. Should be
129 a full path. The bitmap should fit in the place of two
130 characters. This is not checked. If the bitmap is too big it
131 will cause redraw problems. Only GTK 2 can scale the bitmap
132 to fit the space available.
133 toolkit supports ~
134 GTK 1 pixmap (.xpm)
135 GTK 2 many
136 Motif pixmap (.xpm)
Bram Moolenaar6ee8d892012-01-10 14:55:01 +0100137 Win32 .bmp, .ico, .cur
138 pixmap (.xpm) |+xpm_w32|
LemonBoyb975ddf2024-07-06 18:04:09 +0200139 priority={prio}
140 Default priority for the sign, see |sign-priority|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 linehl={group}
143 Highlighting group used for the whole line the sign is placed
144 in. Most useful is defining a background color.
145
James McCoya80aad72021-12-22 19:45:28 +0000146 numhl={group}
147 Highlighting group used for the line number on the line where
148 the sign is placed. Overrides |hl-LineNr|, |hl-LineNrAbove|,
149 |hl-LineNrBelow|, and |hl-CursorLineNr|.
150
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151 text={text} *E239*
152 Define the text that is displayed when there is no icon or the
153 GUI is not being used. Only printable characters are allowed
154 and they must occupy one or two display cells.
155
156 texthl={group}
157 Highlighting group used for the text item.
158
Bram Moolenaar6304be62021-11-27 10:57:26 +0000159 culhl={group}
160 Highlighting group used for the text item when the cursor is
161 on the same line as the sign and 'cursorline' is enabled.
162
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100163 Example: >
164 :sign define MySign text=>> texthl=Search linehl=DiffText
165<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166
167DELETING A SIGN *:sign-undefine* *E155*
168
Bram Moolenaar162b7142018-12-21 15:17:36 +0100169See |sign_undefine()| for the equivalent Vim script function.
170
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171:sign undefine {name}
172 Deletes a previously defined sign. If signs with this {name}
173 are still placed this will cause trouble.
174
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100175 Example: >
176 :sign undefine MySign
177<
Bram Moolenaar162b7142018-12-21 15:17:36 +0100178
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179LISTING SIGNS *:sign-list* *E156*
180
Bram Moolenaar162b7142018-12-21 15:17:36 +0100181See |sign_getdefined()| for the equivalent Vim script function.
182
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183:sign list Lists all defined signs and their attributes.
184
185:sign list {name}
186 Lists one defined sign and its attributes.
187
188
189PLACING SIGNS *:sign-place* *E158*
190
Bram Moolenaar162b7142018-12-21 15:17:36 +0100191See |sign_place()| for the equivalent Vim script function.
192
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193:sign place {id} line={lnum} name={name} file={fname}
194 Place sign defined as {name} at line {lnum} in file {fname}.
195 *:sign-fname*
196 The file {fname} must already be loaded in a buffer. The
197 exact file name must be used, wildcards, $ENV and ~ are not
198 expanded, white space must not be escaped. Trailing white
199 space is ignored.
200
201 The sign is remembered under {id}, this can be used for
202 further manipulation. {id} must be a number.
203 It's up to the user to make sure the {id} is used only once in
204 each file (if it's used several times unplacing will also have
205 to be done several times and making changes may not work as
206 expected).
207
Bram Moolenaar162b7142018-12-21 15:17:36 +0100208 The following optional sign attributes can be specified before
209 "file=":
210 group={group} Place sign in sign group {group}
211 priority={prio} Assign priority {prio} to sign
212
213 By default, the sign is placed in the global sign group.
214
LemonBoyb975ddf2024-07-06 18:04:09 +0200215 By default, the sign is assigned a default priority of 10,
216 unless specified otherwise by the sign definition. To assign a
217 different priority value, use "priority={prio}" to specify a
218 value. The priority is used to determine the sign that is
219 displayed when multiple signs are placed on the same line.
Bram Moolenaar162b7142018-12-21 15:17:36 +0100220
221 Examples: >
222 :sign place 5 line=3 name=sign1 file=a.py
223 :sign place 6 group=g2 line=2 name=sign2 file=x.py
224 :sign place 9 group=g2 priority=50 line=5
225 \ name=sign1 file=a.py
226<
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100227:sign place {id} line={lnum} name={name} [buffer={nr}]
228 Same, but use buffer {nr}. If the buffer argument is not
229 given, place the sign in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100231 Example: >
232 :sign place 10 line=99 name=sign3
233 :sign place 10 line=99 name=sign3 buffer=3
234<
Bram Moolenaare968e362014-05-13 20:23:24 +0200235 *E885*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236:sign place {id} name={name} file={fname}
237 Change the placed sign {id} in file {fname} to use the defined
238 sign {name}. See remark above about {fname} |:sign-fname|.
239 This can be used to change the displayed sign without moving
240 it (e.g., when the debugger has stopped at a breakpoint).
241
Bram Moolenaar162b7142018-12-21 15:17:36 +0100242 The optional "group={group}" attribute can be used before
Bram Moolenaar58a7f872019-06-04 22:48:15 +0200243 "file=" to select a sign in a particular group. The optional
244 "priority={prio}" attribute can be used to change the priority
245 of an existing sign.
Bram Moolenaar162b7142018-12-21 15:17:36 +0100246
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100247 Example: >
248 :sign place 23 name=sign1 file=/path/to/edit.py
249<
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100250:sign place {id} name={name} [buffer={nr}]
251 Same, but use buffer {nr}. If the buffer argument is not
252 given, use the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100254 Example: >
255 :sign place 23 name=sign1
256 :sign place 23 name=sign1 buffer=7
257<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258
259REMOVING SIGNS *:sign-unplace* *E159*
260
Bram Moolenaar162b7142018-12-21 15:17:36 +0100261See |sign_unplace()| for the equivalent Vim script function.
262
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263:sign unplace {id} file={fname}
264 Remove the previously placed sign {id} from file {fname}.
265 See remark above about {fname} |:sign-fname|.
266
Bram Moolenaar162b7142018-12-21 15:17:36 +0100267:sign unplace {id} group={group} file={fname}
268 Same but remove the sign {id} in sign group {group}.
269
270:sign unplace {id} group=* file={fname}
271 Same but remove the sign {id} from all the sign groups.
272
Bram Moolenaarf65e5662012-07-10 15:18:22 +0200273:sign unplace * file={fname}
274 Remove all placed signs in file {fname}.
275
Bram Moolenaar162b7142018-12-21 15:17:36 +0100276:sign unplace * group={group} file={fname}
277 Remove all placed signs in group {group} from file {fname}.
278
279:sign unplace * group=* file={fname}
280 Remove all placed signs in all the groups from file {fname}.
281
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282:sign unplace {id} buffer={nr}
Bram Moolenaarf65e5662012-07-10 15:18:22 +0200283 Remove the previously placed sign {id} from buffer {nr}.
284
Bram Moolenaar162b7142018-12-21 15:17:36 +0100285:sign unplace {id} group={group} buffer={nr}
286 Remove the previously placed sign {id} in group {group} from
287 buffer {nr}.
288
289:sign unplace {id} group=* buffer={nr}
290 Remove the previously placed sign {id} in all the groups from
291 buffer {nr}.
292
Bram Moolenaarf65e5662012-07-10 15:18:22 +0200293:sign unplace * buffer={nr}
294 Remove all placed signs in buffer {nr}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295
Bram Moolenaar162b7142018-12-21 15:17:36 +0100296:sign unplace * group={group} buffer={nr}
297 Remove all placed signs in group {group} from buffer {nr}.
298
299:sign unplace * group=* buffer={nr}
300 Remove all placed signs in all the groups from buffer {nr}.
301
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302:sign unplace {id}
303 Remove the previously placed sign {id} from all files it
304 appears in.
305
Bram Moolenaar162b7142018-12-21 15:17:36 +0100306:sign unplace {id} group={group}
307 Remove the previously placed sign {id} in group {group} from
308 all files it appears in.
309
310:sign unplace {id} group=*
311 Remove the previously placed sign {id} in all the groups from
312 all the files it appears in.
313
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314:sign unplace *
Bram Moolenaar6b7b7192019-01-11 13:42:41 +0100315 Remove all placed signs in the global group from all the files.
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100316
317:sign unplace * group={group}
Bram Moolenaar6b7b7192019-01-11 13:42:41 +0100318 Remove all placed signs in group {group} from all the files.
Bram Moolenaar162b7142018-12-21 15:17:36 +0100319
320:sign unplace * group=*
Bram Moolenaar6b7b7192019-01-11 13:42:41 +0100321 Remove all placed signs in all the groups from all the files.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
323:sign unplace
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100324 Remove a placed sign at the cursor position. If multiple signs
325 are placed in the line, then only one is removed.
326
327:sign unplace group={group}
328 Remove a placed sign in group {group} at the cursor
329 position.
330
331:sign unplace group=*
332 Remove a placed sign in any group at the cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333
334
Bram Moolenaar36782082013-11-28 13:53:34 +0100335LISTING PLACED SIGNS *:sign-place-list*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
Bram Moolenaar162b7142018-12-21 15:17:36 +0100337See |sign_getplaced()| for the equivalent Vim script function.
338
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339:sign place file={fname}
340 List signs placed in file {fname}.
341 See remark above about {fname} |:sign-fname|.
342
Bram Moolenaar162b7142018-12-21 15:17:36 +0100343:sign place group={group} file={fname}
344 List signs in group {group} placed in file {fname}.
345
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100346:sign place group=* file={fname}
347 List signs in all the groups placed in file {fname}.
348
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349:sign place buffer={nr}
350 List signs placed in buffer {nr}.
351
Bram Moolenaar162b7142018-12-21 15:17:36 +0100352:sign place group={group} buffer={nr}
353 List signs in group {group} placed in buffer {nr}.
354
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100355:sign place group=* buffer={nr}
356 List signs in all the groups placed in buffer {nr}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100358:sign place List placed signs in the global group in all files.
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100359
Bram Moolenaar162b7142018-12-21 15:17:36 +0100360:sign place group={group}
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100361 List placed signs with sign group {group} in all files.
Bram Moolenaar162b7142018-12-21 15:17:36 +0100362
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100363:sign place group=*
364 List placed signs in all sign groups in all files.
365
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366
367JUMPING TO A SIGN *:sign-jump* *E157*
368
Bram Moolenaar6b7b7192019-01-11 13:42:41 +0100369See |sign_jump()| for the equivalent Vim script function.
370
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371:sign jump {id} file={fname}
372 Open the file {fname} or jump to the window that contains
373 {fname} and position the cursor at sign {id}.
374 See remark above about {fname} |:sign-fname|.
375 If the file isn't displayed in window and the current file can
376 not be |abandon|ed this fails.
377
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100378:sign jump {id} group={group} file={fname}
379 Same but jump to the sign in group {group}
380
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100381:sign jump {id} [buffer={nr}] *E934*
Bram Moolenaar7571d552016-08-18 22:54:46 +0200382 Same, but use buffer {nr}. This fails if buffer {nr} does not
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100383 have a name. If the buffer argument is not given, use the
384 current buffer.
Bram Moolenaar7571d552016-08-18 22:54:46 +0200385
Bram Moolenaarb328cca2019-01-06 16:24:01 +0100386:sign jump {id} group={group} [buffer={nr}]
Bram Moolenaar7d83bf42018-12-29 18:53:55 +0100387 Same but jump to the sign in group {group}
388
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389
Bram Moolenaared997ad2019-07-21 16:42:00 +0200390==============================================================================
3913. Functions *sign-functions-details*
392
393sign_define({name} [, {dict}]) *sign_define()*
394sign_define({list})
395 Define a new sign named {name} or modify the attributes of an
396 existing sign. This is similar to the |:sign-define| command.
397
398 Prefix {name} with a unique text to avoid name collisions.
399 There is no {group} like with placing signs.
400
401 The {name} can be a String or a Number. The optional {dict}
402 argument specifies the sign attributes. The following values
403 are supported:
404 icon full path to the bitmap file for the sign.
405 linehl highlight group used for the whole line the
406 sign is placed in.
zeertzjqfc3f5db2024-07-07 20:33:46 +0200407 priority default priority value of the sign
James McCoya80aad72021-12-22 19:45:28 +0000408 numhl highlight group used for the line number where
409 the sign is placed.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200410 text text that is displayed when there is no icon
411 or the GUI is not being used.
412 texthl highlight group used for the text item
Bram Moolenaare413ea02021-11-24 16:20:13 +0000413 culhl highlight group used for the text item when
414 the cursor is on the same line as the sign and
415 'cursorline' is enabled.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200416
417 If the sign named {name} already exists, then the attributes
418 of the sign are updated.
419
420 The one argument {list} can be used to define a list of signs.
421 Each list item is a dictionary with the above items in {dict}
Bram Moolenaar0c0734d2019-11-26 21:44:46 +0100422 and a "name" item for the sign name.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200423
424 Returns 0 on success and -1 on failure. When the one argument
425 {list} is used, then returns a List of values one for each
426 defined sign.
427
428 Examples: >
429 call sign_define("mySign", {
430 \ "text" : "=>",
431 \ "texthl" : "Error",
432 \ "linehl" : "Search"})
433 call sign_define([
434 \ {'name' : 'sign1',
435 \ 'text' : '=>'},
436 \ {'name' : 'sign2',
437 \ 'text' : '!!'}
438 \ ])
439<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200440 Can also be used as a |method|: >
441 GetSignList()->sign_define()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200442<
443 Return type: |Number|
444
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200445
Bram Moolenaared997ad2019-07-21 16:42:00 +0200446sign_getdefined([{name}]) *sign_getdefined()*
447 Get a list of defined signs and their attributes.
448 This is similar to the |:sign-list| command.
449
450 If the {name} is not supplied, then a list of all the defined
451 signs is returned. Otherwise the attribute of the specified
452 sign is returned.
453
454 Each list item in the returned value is a dictionary with the
455 following entries:
456 icon full path to the bitmap file of the sign
457 linehl highlight group used for the whole line the
Bram Moolenaar47003982021-12-05 21:54:04 +0000458 sign is placed in; not present if not set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200459 name name of the sign
LemonBoyb975ddf2024-07-06 18:04:09 +0200460 priority default priority value of the sign
James McCoya80aad72021-12-22 19:45:28 +0000461 numhl highlight group used for the line number where
462 the sign is placed; not present if not set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200463 text text that is displayed when there is no icon
464 or the GUI is not being used.
Bram Moolenaar47003982021-12-05 21:54:04 +0000465 texthl highlight group used for the text item; not
466 present if not set
Bram Moolenaare413ea02021-11-24 16:20:13 +0000467 culhl highlight group used for the text item when
468 the cursor is on the same line as the sign and
Bram Moolenaar47003982021-12-05 21:54:04 +0000469 'cursorline' is enabled; not present if not
470 set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200471
472 Returns an empty List if there are no signs and when {name} is
473 not found.
474
475 Examples: >
476 " Get a list of all the defined signs
477 echo sign_getdefined()
478
479 " Get the attribute of the sign named mySign
480 echo sign_getdefined("mySign")
481<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200482 Can also be used as a |method|: >
483 GetSignList()->sign_getdefined()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200484<
485 Return type: list<dict<string>> or list<any>
486
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200487
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200488sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
Bram Moolenaared997ad2019-07-21 16:42:00 +0200489 Return a list of signs placed in a buffer or all the buffers.
490 This is similar to the |:sign-place-list| command.
491
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200492 If the optional buffer name {buf} is specified, then only the
Bram Moolenaared997ad2019-07-21 16:42:00 +0200493 list of signs placed in that buffer is returned. For the use
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200494 of {buf}, see |bufname()|. The optional {dict} can contain
Bram Moolenaared997ad2019-07-21 16:42:00 +0200495 the following entries:
496 group select only signs in this group
497 id select sign with this identifier
498 lnum select signs placed in this line. For the use
499 of {lnum}, see |line()|.
500 If {group} is '*', then signs in all the groups including the
501 global group are returned. If {group} is not supplied or is an
502 empty string, then only signs in the global group are
503 returned. If no arguments are supplied, then signs in the
504 global group placed in all the buffers are returned.
505 See |sign-group|.
506
507 Each list item in the returned value is a dictionary with the
508 following entries:
509 bufnr number of the buffer with the sign
510 signs list of signs placed in {bufnr}. Each list
511 item is a dictionary with the below listed
512 entries
513
514 The dictionary for each sign contains the following entries:
Bram Moolenaar3132cdd2020-11-05 20:41:49 +0100515 group sign group. Set to '' for the global group.
516 id identifier of the sign
517 lnum line number where the sign is placed
518 name name of the defined sign
519 priority sign priority
Bram Moolenaared997ad2019-07-21 16:42:00 +0200520
521 The returned signs in a buffer are ordered by their line
522 number and priority.
523
524 Returns an empty list on failure or if there are no placed
525 signs.
526
527 Examples: >
528 " Get a List of signs placed in eval.c in the
529 " global group
530 echo sign_getplaced("eval.c")
531
532 " Get a List of signs in group 'g1' placed in eval.c
533 echo sign_getplaced("eval.c", {'group' : 'g1'})
534
535 " Get a List of signs placed at line 10 in eval.c
536 echo sign_getplaced("eval.c", {'lnum' : 10})
537
538 " Get sign with identifier 10 placed in a.py
539 echo sign_getplaced("a.py", {'id' : 10})
540
541 " Get sign with id 20 in group 'g1' placed in a.py
542 echo sign_getplaced("a.py", {'group' : 'g1',
543 \ 'id' : 20})
544
545 " Get a List of all the placed signs
546 echo sign_getplaced()
547<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200548 Can also be used as a |method|: >
549 GetBufname()->sign_getplaced()
550<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200551 Return type: list<dict<any>>
552
553
554sign_jump({id}, {group}, {buf}) *sign_jump()*
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200555 Open the buffer {buf} or jump to the window that contains
556 {buf} and position the cursor at sign {id} in group {group}.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200557 This is similar to the |:sign-jump| command.
558
Yegappan Lakshmanan820d5522021-09-17 21:07:35 +0200559 If {group} is an empty string, then the global group is used.
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200560 For the use of {buf}, see |bufname()|.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200561
562 Returns the line number of the sign. Returns -1 if the
563 arguments are invalid.
564
565 Example: >
566 " Jump to sign 10 in the current buffer
567 call sign_jump(10, '', '')
568<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200569 Can also be used as a |method|: >
570 GetSignid()->sign_jump()
571<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200572 Return type: |Number|
573
574
Bram Moolenaared997ad2019-07-21 16:42:00 +0200575 *sign_place()*
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200576sign_place({id}, {group}, {name}, {buf} [, {dict}])
Bram Moolenaared997ad2019-07-21 16:42:00 +0200577 Place the sign defined as {name} at line {lnum} in file or
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200578 buffer {buf} and assign {id} and {group} to sign. This is
Bram Moolenaared997ad2019-07-21 16:42:00 +0200579 similar to the |:sign-place| command.
580
581 If the sign identifier {id} is zero, then a new identifier is
582 allocated. Otherwise the specified number is used. {group} is
583 the sign group name. To use the global sign group, use an
584 empty string. {group} functions as a namespace for {id}, thus
585 two groups can use the same IDs. Refer to |sign-identifier|
586 and |sign-group| for more information.
587
588 {name} refers to a defined sign.
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200589 {buf} refers to a buffer name or number. For the accepted
Bram Moolenaared997ad2019-07-21 16:42:00 +0200590 values, see |bufname()|.
591
592 The optional {dict} argument supports the following entries:
593 lnum line number in the file or buffer
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200594 {buf} where the sign is to be placed.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200595 For the accepted values, see |line()|.
596 priority priority of the sign. See
597 |sign-priority| for more information.
598
599 If the optional {dict} is not specified, then it modifies the
600 placed sign {id} in group {group} to use the defined sign
601 {name}.
602
603 Returns the sign identifier on success and -1 on failure.
604
605 Examples: >
606 " Place a sign named sign1 with id 5 at line 20 in
607 " buffer json.c
608 call sign_place(5, '', 'sign1', 'json.c',
609 \ {'lnum' : 20})
610
611 " Updates sign 5 in buffer json.c to use sign2
612 call sign_place(5, '', 'sign2', 'json.c')
613
614 " Place a sign named sign3 at line 30 in
615 " buffer json.c with a new identifier
616 let id = sign_place(0, '', 'sign3', 'json.c',
617 \ {'lnum' : 30})
618
619 " Place a sign named sign4 with id 10 in group 'g3'
620 " at line 40 in buffer json.c with priority 90
621 call sign_place(10, 'g3', 'sign4', 'json.c',
622 \ {'lnum' : 40, 'priority' : 90})
623<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200624 Can also be used as a |method|: >
625 GetSignid()->sign_place(group, name, expr)
626<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200627 Return type: |Number|
628
629
630sign_placelist({list}) *sign_placelist()*
Bram Moolenaared997ad2019-07-21 16:42:00 +0200631 Place one or more signs. This is similar to the
632 |sign_place()| function. The {list} argument specifies the
633 List of signs to place. Each list item is a dict with the
634 following sign attributes:
Bram Moolenaardd60c362023-02-27 15:49:53 +0000635 buffer Buffer name or number. For the accepted
Bram Moolenaared997ad2019-07-21 16:42:00 +0200636 values, see |bufname()|.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000637 group Sign group. {group} functions as a namespace
Bram Moolenaared997ad2019-07-21 16:42:00 +0200638 for {id}, thus two groups can use the same
639 IDs. If not specified or set to an empty
640 string, then the global group is used. See
641 |sign-group| for more information.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000642 id Sign identifier. If not specified or zero,
Bram Moolenaared997ad2019-07-21 16:42:00 +0200643 then a new unique identifier is allocated.
644 Otherwise the specified number is used. See
645 |sign-identifier| for more information.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000646 lnum Line number in the buffer where the sign is to
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000647 be placed. For the accepted values, see
648 |line()|.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000649 name Name of the sign to place. See |sign_define()|
650 for more information.
651 priority Priority of the sign. When multiple signs are
Bram Moolenaared997ad2019-07-21 16:42:00 +0200652 placed on a line, the sign with the highest
653 priority is used. If not specified, the
LemonBoyb975ddf2024-07-06 18:04:09 +0200654 default value of 10 is used, unless specified
655 otherwise by the sign definition. See
Bram Moolenaared997ad2019-07-21 16:42:00 +0200656 |sign-priority| for more information.
657
658 If {id} refers to an existing sign, then the existing sign is
659 modified to use the specified {name} and/or {priority}.
660
661 Returns a List of sign identifiers. If failed to place a
662 sign, the corresponding list item is set to -1.
663
664 Examples: >
665 " Place sign s1 with id 5 at line 20 and id 10 at line
666 " 30 in buffer a.c
667 let [n1, n2] = sign_placelist([
668 \ {'id' : 5,
669 \ 'name' : 's1',
670 \ 'buffer' : 'a.c',
671 \ 'lnum' : 20},
672 \ {'id' : 10,
673 \ 'name' : 's1',
674 \ 'buffer' : 'a.c',
675 \ 'lnum' : 30}
676 \ ])
677
678 " Place sign s1 in buffer a.c at line 40 and 50
679 " with auto-generated identifiers
680 let [n1, n2] = sign_placelist([
681 \ {'name' : 's1',
682 \ 'buffer' : 'a.c',
683 \ 'lnum' : 40},
684 \ {'name' : 's1',
685 \ 'buffer' : 'a.c',
686 \ 'lnum' : 50}
687 \ ])
688<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200689 Can also be used as a |method|: >
690 GetSignlist()->sign_placelist()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200691<
692 Return type: |Number|
693
Bram Moolenaared997ad2019-07-21 16:42:00 +0200694
695sign_undefine([{name}]) *sign_undefine()*
696sign_undefine({list})
697 Deletes a previously defined sign {name}. This is similar to
698 the |:sign-undefine| command. If {name} is not supplied, then
699 deletes all the defined signs.
700
701 The one argument {list} can be used to undefine a list of
702 signs. Each list item is the name of a sign.
703
704 Returns 0 on success and -1 on failure. For the one argument
705 {list} call, returns a list of values one for each undefined
706 sign.
707
708 Examples: >
709 " Delete a sign named mySign
710 call sign_undefine("mySign")
711
712 " Delete signs 'sign1' and 'sign2'
713 call sign_undefine(["sign1", "sign2"])
714
715 " Delete all the signs
716 call sign_undefine()
717<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200718 Can also be used as a |method|: >
719 GetSignlist()->sign_undefine()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200720<
721 Return type: |Number|
722
Bram Moolenaared997ad2019-07-21 16:42:00 +0200723
724sign_unplace({group} [, {dict}]) *sign_unplace()*
725 Remove a previously placed sign in one or more buffers. This
726 is similar to the |:sign-unplace| command.
727
728 {group} is the sign group name. To use the global sign group,
729 use an empty string. If {group} is set to '*', then all the
730 groups including the global group are used.
731 The signs in {group} are selected based on the entries in
732 {dict}. The following optional entries in {dict} are
733 supported:
734 buffer buffer name or number. See |bufname()|.
735 id sign identifier
736 If {dict} is not supplied, then all the signs in {group} are
737 removed.
738
739 Returns 0 on success and -1 on failure.
740
741 Examples: >
742 " Remove sign 10 from buffer a.vim
743 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
744
745 " Remove sign 20 in group 'g1' from buffer 3
746 call sign_unplace('g1', {'buffer' : 3, 'id' : 20})
747
748 " Remove all the signs in group 'g2' from buffer 10
749 call sign_unplace('g2', {'buffer' : 10})
750
751 " Remove sign 30 in group 'g3' from all the buffers
752 call sign_unplace('g3', {'id' : 30})
753
754 " Remove all the signs placed in buffer 5
755 call sign_unplace('*', {'buffer' : 5})
756
757 " Remove the signs in group 'g4' from all the buffers
758 call sign_unplace('g4')
759
760 " Remove sign 40 from all the buffers
761 call sign_unplace('*', {'id' : 40})
762
763 " Remove all the placed signs from all the buffers
764 call sign_unplace('*')
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200765
766< Can also be used as a |method|: >
767 GetSigngroup()->sign_unplace()
Bram Moolenaared997ad2019-07-21 16:42:00 +0200768<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200769 Return type: |Number|
770
771
Bram Moolenaared997ad2019-07-21 16:42:00 +0200772sign_unplacelist({list}) *sign_unplacelist()*
773 Remove previously placed signs from one or more buffers. This
774 is similar to the |sign_unplace()| function.
775
776 The {list} argument specifies the List of signs to remove.
777 Each list item is a dict with the following sign attributes:
778 buffer buffer name or number. For the accepted
779 values, see |bufname()|. If not specified,
780 then the specified sign is removed from all
781 the buffers.
782 group sign group name. If not specified or set to an
783 empty string, then the global sign group is
784 used. If set to '*', then all the groups
785 including the global group are used.
786 id sign identifier. If not specified, then all
787 the signs in the specified group are removed.
788
789 Returns a List where an entry is set to 0 if the corresponding
790 sign was successfully removed or -1 on failure.
791
792 Example: >
793 " Remove sign with id 10 from buffer a.vim and sign
794 " with id 20 from buffer b.vim
795 call sign_unplacelist([
796 \ {'id' : 10, 'buffer' : "a.vim"},
797 \ {'id' : 20, 'buffer' : 'b.vim'},
798 \ ])
799<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200800 Can also be used as a |method|: >
801 GetSignlist()->sign_unplacelist()
802<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200803 Return type: list<number> or list<any>
Bram Moolenaared997ad2019-07-21 16:42:00 +0200804
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200805 vim:tw=78:ts=8:noet:ft=help:norl: