blob: 84b2977293a5e5bbd5b5d45959b3276b29586607 [file] [log] [blame]
LemonBoyb975ddf2024-07-06 18:04:09 +02001*sign.txt* For Vim version 9.1. Last change: 2024 Jul 06
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.
James McCoya80aad72021-12-22 19:45:28 +0000407 numhl highlight group used for the line number where
408 the sign is placed.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200409 text text that is displayed when there is no icon
410 or the GUI is not being used.
411 texthl highlight group used for the text item
Bram Moolenaare413ea02021-11-24 16:20:13 +0000412 culhl highlight group used for the text item when
413 the cursor is on the same line as the sign and
414 'cursorline' is enabled.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200415
416 If the sign named {name} already exists, then the attributes
417 of the sign are updated.
418
419 The one argument {list} can be used to define a list of signs.
420 Each list item is a dictionary with the above items in {dict}
Bram Moolenaar0c0734d2019-11-26 21:44:46 +0100421 and a "name" item for the sign name.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200422
423 Returns 0 on success and -1 on failure. When the one argument
424 {list} is used, then returns a List of values one for each
425 defined sign.
426
427 Examples: >
428 call sign_define("mySign", {
429 \ "text" : "=>",
430 \ "texthl" : "Error",
431 \ "linehl" : "Search"})
432 call sign_define([
433 \ {'name' : 'sign1',
434 \ 'text' : '=>'},
435 \ {'name' : 'sign2',
436 \ 'text' : '!!'}
437 \ ])
438<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200439 Can also be used as a |method|: >
440 GetSignList()->sign_define()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200441<
442 Return type: |Number|
443
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200444
Bram Moolenaared997ad2019-07-21 16:42:00 +0200445sign_getdefined([{name}]) *sign_getdefined()*
446 Get a list of defined signs and their attributes.
447 This is similar to the |:sign-list| command.
448
449 If the {name} is not supplied, then a list of all the defined
450 signs is returned. Otherwise the attribute of the specified
451 sign is returned.
452
453 Each list item in the returned value is a dictionary with the
454 following entries:
455 icon full path to the bitmap file of the sign
456 linehl highlight group used for the whole line the
Bram Moolenaar47003982021-12-05 21:54:04 +0000457 sign is placed in; not present if not set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200458 name name of the sign
LemonBoyb975ddf2024-07-06 18:04:09 +0200459 priority default priority value of the sign
James McCoya80aad72021-12-22 19:45:28 +0000460 numhl highlight group used for the line number where
461 the sign is placed; not present if not set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200462 text text that is displayed when there is no icon
463 or the GUI is not being used.
Bram Moolenaar47003982021-12-05 21:54:04 +0000464 texthl highlight group used for the text item; not
465 present if not set
Bram Moolenaare413ea02021-11-24 16:20:13 +0000466 culhl highlight group used for the text item when
467 the cursor is on the same line as the sign and
Bram Moolenaar47003982021-12-05 21:54:04 +0000468 'cursorline' is enabled; not present if not
469 set
Bram Moolenaared997ad2019-07-21 16:42:00 +0200470
471 Returns an empty List if there are no signs and when {name} is
472 not found.
473
474 Examples: >
475 " Get a list of all the defined signs
476 echo sign_getdefined()
477
478 " Get the attribute of the sign named mySign
479 echo sign_getdefined("mySign")
480<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200481 Can also be used as a |method|: >
482 GetSignList()->sign_getdefined()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200483<
484 Return type: list<dict<string>> or list<any>
485
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200486
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200487sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
Bram Moolenaared997ad2019-07-21 16:42:00 +0200488 Return a list of signs placed in a buffer or all the buffers.
489 This is similar to the |:sign-place-list| command.
490
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200491 If the optional buffer name {buf} is specified, then only the
Bram Moolenaared997ad2019-07-21 16:42:00 +0200492 list of signs placed in that buffer is returned. For the use
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200493 of {buf}, see |bufname()|. The optional {dict} can contain
Bram Moolenaared997ad2019-07-21 16:42:00 +0200494 the following entries:
495 group select only signs in this group
496 id select sign with this identifier
497 lnum select signs placed in this line. For the use
498 of {lnum}, see |line()|.
499 If {group} is '*', then signs in all the groups including the
500 global group are returned. If {group} is not supplied or is an
501 empty string, then only signs in the global group are
502 returned. If no arguments are supplied, then signs in the
503 global group placed in all the buffers are returned.
504 See |sign-group|.
505
506 Each list item in the returned value is a dictionary with the
507 following entries:
508 bufnr number of the buffer with the sign
509 signs list of signs placed in {bufnr}. Each list
510 item is a dictionary with the below listed
511 entries
512
513 The dictionary for each sign contains the following entries:
Bram Moolenaar3132cdd2020-11-05 20:41:49 +0100514 group sign group. Set to '' for the global group.
515 id identifier of the sign
516 lnum line number where the sign is placed
517 name name of the defined sign
518 priority sign priority
Bram Moolenaared997ad2019-07-21 16:42:00 +0200519
520 The returned signs in a buffer are ordered by their line
521 number and priority.
522
523 Returns an empty list on failure or if there are no placed
524 signs.
525
526 Examples: >
527 " Get a List of signs placed in eval.c in the
528 " global group
529 echo sign_getplaced("eval.c")
530
531 " Get a List of signs in group 'g1' placed in eval.c
532 echo sign_getplaced("eval.c", {'group' : 'g1'})
533
534 " Get a List of signs placed at line 10 in eval.c
535 echo sign_getplaced("eval.c", {'lnum' : 10})
536
537 " Get sign with identifier 10 placed in a.py
538 echo sign_getplaced("a.py", {'id' : 10})
539
540 " Get sign with id 20 in group 'g1' placed in a.py
541 echo sign_getplaced("a.py", {'group' : 'g1',
542 \ 'id' : 20})
543
544 " Get a List of all the placed signs
545 echo sign_getplaced()
546<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200547 Can also be used as a |method|: >
548 GetBufname()->sign_getplaced()
549<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200550 Return type: list<dict<any>>
551
552
553sign_jump({id}, {group}, {buf}) *sign_jump()*
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200554 Open the buffer {buf} or jump to the window that contains
555 {buf} and position the cursor at sign {id} in group {group}.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200556 This is similar to the |:sign-jump| command.
557
Yegappan Lakshmanan820d5522021-09-17 21:07:35 +0200558 If {group} is an empty string, then the global group is used.
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200559 For the use of {buf}, see |bufname()|.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200560
561 Returns the line number of the sign. Returns -1 if the
562 arguments are invalid.
563
564 Example: >
565 " Jump to sign 10 in the current buffer
566 call sign_jump(10, '', '')
567<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200568 Can also be used as a |method|: >
569 GetSignid()->sign_jump()
570<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200571 Return type: |Number|
572
573
Bram Moolenaared997ad2019-07-21 16:42:00 +0200574 *sign_place()*
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200575sign_place({id}, {group}, {name}, {buf} [, {dict}])
Bram Moolenaared997ad2019-07-21 16:42:00 +0200576 Place the sign defined as {name} at line {lnum} in file or
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200577 buffer {buf} and assign {id} and {group} to sign. This is
Bram Moolenaared997ad2019-07-21 16:42:00 +0200578 similar to the |:sign-place| command.
579
580 If the sign identifier {id} is zero, then a new identifier is
581 allocated. Otherwise the specified number is used. {group} is
582 the sign group name. To use the global sign group, use an
583 empty string. {group} functions as a namespace for {id}, thus
584 two groups can use the same IDs. Refer to |sign-identifier|
585 and |sign-group| for more information.
586
587 {name} refers to a defined sign.
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200588 {buf} refers to a buffer name or number. For the accepted
Bram Moolenaared997ad2019-07-21 16:42:00 +0200589 values, see |bufname()|.
590
591 The optional {dict} argument supports the following entries:
592 lnum line number in the file or buffer
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200593 {buf} where the sign is to be placed.
Bram Moolenaared997ad2019-07-21 16:42:00 +0200594 For the accepted values, see |line()|.
595 priority priority of the sign. See
596 |sign-priority| for more information.
597
598 If the optional {dict} is not specified, then it modifies the
599 placed sign {id} in group {group} to use the defined sign
600 {name}.
601
602 Returns the sign identifier on success and -1 on failure.
603
604 Examples: >
605 " Place a sign named sign1 with id 5 at line 20 in
606 " buffer json.c
607 call sign_place(5, '', 'sign1', 'json.c',
608 \ {'lnum' : 20})
609
610 " Updates sign 5 in buffer json.c to use sign2
611 call sign_place(5, '', 'sign2', 'json.c')
612
613 " Place a sign named sign3 at line 30 in
614 " buffer json.c with a new identifier
615 let id = sign_place(0, '', 'sign3', 'json.c',
616 \ {'lnum' : 30})
617
618 " Place a sign named sign4 with id 10 in group 'g3'
619 " at line 40 in buffer json.c with priority 90
620 call sign_place(10, 'g3', 'sign4', 'json.c',
621 \ {'lnum' : 40, 'priority' : 90})
622<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200623 Can also be used as a |method|: >
624 GetSignid()->sign_place(group, name, expr)
625<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200626 Return type: |Number|
627
628
629sign_placelist({list}) *sign_placelist()*
Bram Moolenaared997ad2019-07-21 16:42:00 +0200630 Place one or more signs. This is similar to the
631 |sign_place()| function. The {list} argument specifies the
632 List of signs to place. Each list item is a dict with the
633 following sign attributes:
Bram Moolenaardd60c362023-02-27 15:49:53 +0000634 buffer Buffer name or number. For the accepted
Bram Moolenaared997ad2019-07-21 16:42:00 +0200635 values, see |bufname()|.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000636 group Sign group. {group} functions as a namespace
Bram Moolenaared997ad2019-07-21 16:42:00 +0200637 for {id}, thus two groups can use the same
638 IDs. If not specified or set to an empty
639 string, then the global group is used. See
640 |sign-group| for more information.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000641 id Sign identifier. If not specified or zero,
Bram Moolenaared997ad2019-07-21 16:42:00 +0200642 then a new unique identifier is allocated.
643 Otherwise the specified number is used. See
644 |sign-identifier| for more information.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000645 lnum Line number in the buffer where the sign is to
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000646 be placed. For the accepted values, see
647 |line()|.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000648 name Name of the sign to place. See |sign_define()|
649 for more information.
650 priority Priority of the sign. When multiple signs are
Bram Moolenaared997ad2019-07-21 16:42:00 +0200651 placed on a line, the sign with the highest
652 priority is used. If not specified, the
LemonBoyb975ddf2024-07-06 18:04:09 +0200653 default value of 10 is used, unless specified
654 otherwise by the sign definition. See
Bram Moolenaared997ad2019-07-21 16:42:00 +0200655 |sign-priority| for more information.
656
657 If {id} refers to an existing sign, then the existing sign is
658 modified to use the specified {name} and/or {priority}.
659
660 Returns a List of sign identifiers. If failed to place a
661 sign, the corresponding list item is set to -1.
662
663 Examples: >
664 " Place sign s1 with id 5 at line 20 and id 10 at line
665 " 30 in buffer a.c
666 let [n1, n2] = sign_placelist([
667 \ {'id' : 5,
668 \ 'name' : 's1',
669 \ 'buffer' : 'a.c',
670 \ 'lnum' : 20},
671 \ {'id' : 10,
672 \ 'name' : 's1',
673 \ 'buffer' : 'a.c',
674 \ 'lnum' : 30}
675 \ ])
676
677 " Place sign s1 in buffer a.c at line 40 and 50
678 " with auto-generated identifiers
679 let [n1, n2] = sign_placelist([
680 \ {'name' : 's1',
681 \ 'buffer' : 'a.c',
682 \ 'lnum' : 40},
683 \ {'name' : 's1',
684 \ 'buffer' : 'a.c',
685 \ 'lnum' : 50}
686 \ ])
687<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200688 Can also be used as a |method|: >
689 GetSignlist()->sign_placelist()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200690<
691 Return type: |Number|
692
Bram Moolenaared997ad2019-07-21 16:42:00 +0200693
694sign_undefine([{name}]) *sign_undefine()*
695sign_undefine({list})
696 Deletes a previously defined sign {name}. This is similar to
697 the |:sign-undefine| command. If {name} is not supplied, then
698 deletes all the defined signs.
699
700 The one argument {list} can be used to undefine a list of
701 signs. Each list item is the name of a sign.
702
703 Returns 0 on success and -1 on failure. For the one argument
704 {list} call, returns a list of values one for each undefined
705 sign.
706
707 Examples: >
708 " Delete a sign named mySign
709 call sign_undefine("mySign")
710
711 " Delete signs 'sign1' and 'sign2'
712 call sign_undefine(["sign1", "sign2"])
713
714 " Delete all the signs
715 call sign_undefine()
716<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200717 Can also be used as a |method|: >
718 GetSignlist()->sign_undefine()
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200719<
720 Return type: |Number|
721
Bram Moolenaared997ad2019-07-21 16:42:00 +0200722
723sign_unplace({group} [, {dict}]) *sign_unplace()*
724 Remove a previously placed sign in one or more buffers. This
725 is similar to the |:sign-unplace| command.
726
727 {group} is the sign group name. To use the global sign group,
728 use an empty string. If {group} is set to '*', then all the
729 groups including the global group are used.
730 The signs in {group} are selected based on the entries in
731 {dict}. The following optional entries in {dict} are
732 supported:
733 buffer buffer name or number. See |bufname()|.
734 id sign identifier
735 If {dict} is not supplied, then all the signs in {group} are
736 removed.
737
738 Returns 0 on success and -1 on failure.
739
740 Examples: >
741 " Remove sign 10 from buffer a.vim
742 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
743
744 " Remove sign 20 in group 'g1' from buffer 3
745 call sign_unplace('g1', {'buffer' : 3, 'id' : 20})
746
747 " Remove all the signs in group 'g2' from buffer 10
748 call sign_unplace('g2', {'buffer' : 10})
749
750 " Remove sign 30 in group 'g3' from all the buffers
751 call sign_unplace('g3', {'id' : 30})
752
753 " Remove all the signs placed in buffer 5
754 call sign_unplace('*', {'buffer' : 5})
755
756 " Remove the signs in group 'g4' from all the buffers
757 call sign_unplace('g4')
758
759 " Remove sign 40 from all the buffers
760 call sign_unplace('*', {'id' : 40})
761
762 " Remove all the placed signs from all the buffers
763 call sign_unplace('*')
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200764
765< Can also be used as a |method|: >
766 GetSigngroup()->sign_unplace()
Bram Moolenaared997ad2019-07-21 16:42:00 +0200767<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200768 Return type: |Number|
769
770
Bram Moolenaared997ad2019-07-21 16:42:00 +0200771sign_unplacelist({list}) *sign_unplacelist()*
772 Remove previously placed signs from one or more buffers. This
773 is similar to the |sign_unplace()| function.
774
775 The {list} argument specifies the List of signs to remove.
776 Each list item is a dict with the following sign attributes:
777 buffer buffer name or number. For the accepted
778 values, see |bufname()|. If not specified,
779 then the specified sign is removed from all
780 the buffers.
781 group sign group name. If not specified or set to an
782 empty string, then the global sign group is
783 used. If set to '*', then all the groups
784 including the global group are used.
785 id sign identifier. If not specified, then all
786 the signs in the specified group are removed.
787
788 Returns a List where an entry is set to 0 if the corresponding
789 sign was successfully removed or -1 on failure.
790
791 Example: >
792 " Remove sign with id 10 from buffer a.vim and sign
793 " with id 20 from buffer b.vim
794 call sign_unplacelist([
795 \ {'id' : 10, 'buffer' : "a.vim"},
796 \ {'id' : 20, 'buffer' : 'b.vim'},
797 \ ])
798<
Bram Moolenaar93476fd2019-09-06 22:00:54 +0200799 Can also be used as a |method|: >
800 GetSignlist()->sign_unplacelist()
801<
Christian Brabandt5674c9a2024-06-09 00:13:43 +0200802 Return type: list<number> or list<any>
Bram Moolenaared997ad2019-07-21 16:42:00 +0200803
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200804 vim:tw=78:ts=8:noet:ft=help:norl: