blob: 168b1808fb9e33597d46e3952bcf2491db5880e2 [file] [log] [blame]
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar45dd07f2019-05-15 22:45:37 +020011 * Text properties implementation. See ":help text-properties".
Bram Moolenaar98aefe72018-12-13 22:20:09 +010012 */
13
14#include "vim.h"
15
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +010016#if defined(FEAT_PROP_POPUP) || defined(PROTO)
Bram Moolenaar98aefe72018-12-13 22:20:09 +010017
18/*
19 * In a hashtable item "hi_key" points to "pt_name" in a proptype_T.
20 * This avoids adding a pointer to the hashtable item.
21 * PT2HIKEY() converts a proptype pointer to a hashitem key pointer.
22 * HIKEY2PT() converts a hashitem key pointer to a proptype pointer.
23 * HI2PT() converts a hashitem pointer to a proptype pointer.
24 */
25#define PT2HIKEY(p) ((p)->pt_name)
26#define HIKEY2PT(p) ((proptype_T *)((p) - offsetof(proptype_T, pt_name)))
27#define HI2PT(hi) HIKEY2PT((hi)->hi_key)
28
29// The global text property types.
30static hashtab_T *global_proptypes = NULL;
Bram Moolenaare44336b2022-08-07 18:20:08 +010031static proptype_T **global_proparray = NULL;
Bram Moolenaar98aefe72018-12-13 22:20:09 +010032
33// The last used text property type ID.
34static int proptype_id = 0;
35
Bram Moolenaar98aefe72018-12-13 22:20:09 +010036/*
37 * Find a property type by name, return the hashitem.
38 * Returns NULL if the item can't be found.
39 */
40 static hashitem_T *
Bram Moolenaare44336b2022-08-07 18:20:08 +010041find_prop_type_hi(char_u *name, buf_T *buf)
Bram Moolenaar98aefe72018-12-13 22:20:09 +010042{
43 hashtab_T *ht;
44 hashitem_T *hi;
45
46 if (*name == NUL)
47 return NULL;
48 if (buf == NULL)
49 ht = global_proptypes;
50 else
51 ht = buf->b_proptypes;
52
53 if (ht == NULL)
54 return NULL;
55 hi = hash_find(ht, name);
56 if (HASHITEM_EMPTY(hi))
57 return NULL;
58 return hi;
59}
60
61/*
Bram Moolenaare44336b2022-08-07 18:20:08 +010062 * Like find_prop_type_hi() but return the property type.
Bram Moolenaar98aefe72018-12-13 22:20:09 +010063 */
64 static proptype_T *
Bram Moolenaare44336b2022-08-07 18:20:08 +010065find_prop_type(char_u *name, buf_T *buf)
Bram Moolenaar98aefe72018-12-13 22:20:09 +010066{
Bram Moolenaare44336b2022-08-07 18:20:08 +010067 hashitem_T *hi = find_prop_type_hi(name, buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +010068
69 if (hi == NULL)
70 return NULL;
71 return HI2PT(hi);
72}
73
74/*
Bram Moolenaar12034e22019-08-25 22:25:02 +020075 * Get the prop type ID of "name".
76 * When not found return zero.
77 */
78 int
79find_prop_type_id(char_u *name, buf_T *buf)
80{
Bram Moolenaare44336b2022-08-07 18:20:08 +010081 proptype_T *pt = find_prop_type(name, buf);
Bram Moolenaar12034e22019-08-25 22:25:02 +020082
83 if (pt == NULL)
84 return 0;
85 return pt->pt_id;
86}
87
88/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +010089 * Lookup a property type by name. First in "buf" and when not found in the
90 * global types.
91 * When not found gives an error message and returns NULL.
92 */
93 static proptype_T *
94lookup_prop_type(char_u *name, buf_T *buf)
95{
Bram Moolenaare44336b2022-08-07 18:20:08 +010096 proptype_T *type = find_prop_type(name, buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +010097
98 if (type == NULL)
Bram Moolenaare44336b2022-08-07 18:20:08 +010099 type = find_prop_type(name, NULL);
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100100 if (type == NULL)
Bram Moolenaara9fa8c52023-01-02 18:10:04 +0000101 semsg(_(e_property_type_str_does_not_exist), name);
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100102 return type;
103}
104
105/*
106 * Get an optional "bufnr" item from the dict in "arg".
107 * When the argument is not used or "bufnr" is not present then "buf" is
108 * unchanged.
109 * If "bufnr" is valid or not present return OK.
Bram Moolenaar32aa1022019-11-02 22:54:41 +0100110 * When "arg" is not a dict or "bufnr" is invalid return FAIL.
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100111 */
112 static int
113get_bufnr_from_arg(typval_T *arg, buf_T **buf)
114{
115 dictitem_T *di;
116
117 if (arg->v_type != VAR_DICT)
118 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000119 emsg(_(e_dictionary_required));
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100120 return FAIL;
121 }
122 if (arg->vval.v_dict == NULL)
123 return OK; // NULL dict is like an empty dict
124 di = dict_find(arg->vval.v_dict, (char_u *)"bufnr", -1);
Martin Tournoije2390c72021-07-28 13:30:16 +0200125 if (di != NULL && (di->di_tv.v_type != VAR_NUMBER
126 || di->di_tv.vval.v_number != 0))
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100127 {
Bram Moolenaarf0884c52019-05-24 21:22:29 +0200128 *buf = get_buf_arg(&di->di_tv);
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100129 if (*buf == NULL)
130 return FAIL;
131 }
132 return OK;
133}
134
135/*
136 * prop_add({lnum}, {col}, {props})
137 */
138 void
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100139f_prop_add(typval_T *argvars, typval_T *rettv)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100140{
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100141 linenr_T start_lnum;
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100142 colnr_T start_col;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100143
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +0200144 if (in_vim9script()
145 && (check_for_number_arg(argvars, 0) == FAIL
146 || check_for_number_arg(argvars, 1) == FAIL
147 || check_for_dict_arg(argvars, 2) == FAIL))
148 return;
149
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100150 start_lnum = tv_get_number(&argvars[0]);
151 start_col = tv_get_number(&argvars[1]);
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +0100152 if (check_for_dict_arg(argvars, 2) == FAIL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100153 return;
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200154
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100155 rettv->vval.v_number = prop_add_common(start_lnum, start_col,
156 argvars[2].vval.v_dict, curbuf, &argvars[2]);
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200157}
158
159/*
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200160 * Attach a text property 'type_name' to the text starting
161 * at [start_lnum, start_col] and ending at [end_lnum, end_col] in
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100162 * the buffer "buf" and assign identifier "id".
163 * When "text" is not NULL add it to buf->b_textprop_text[-id - 1].
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200164 */
165 static int
166prop_add_one(
167 buf_T *buf,
168 char_u *type_name,
169 int id,
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100170 char_u *text_arg,
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100171 int text_padding_left,
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100172 int text_flags,
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200173 linenr_T start_lnum,
174 linenr_T end_lnum,
175 colnr_T start_col,
176 colnr_T end_col)
177{
178 proptype_T *type;
179 linenr_T lnum;
180 int proplen;
181 char_u *props = NULL;
182 char_u *newprops;
183 size_t textlen;
184 char_u *newtext;
185 int i;
186 textprop_T tmp_prop;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100187 char_u *text = text_arg;
188 int res = FAIL;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200189
190 type = lookup_prop_type(type_name, buf);
191 if (type == NULL)
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100192 goto theend;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200193
194 if (start_lnum < 1 || start_lnum > buf->b_ml.ml_line_count)
195 {
Bram Moolenaar8dac2ac2021-12-27 20:57:06 +0000196 semsg(_(e_invalid_line_number_nr), (long)start_lnum);
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100197 goto theend;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200198 }
199 if (end_lnum < start_lnum || end_lnum > buf->b_ml.ml_line_count)
200 {
Bram Moolenaar8dac2ac2021-12-27 20:57:06 +0000201 semsg(_(e_invalid_line_number_nr), (long)end_lnum);
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100202 goto theend;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200203 }
204
205 if (buf->b_ml.ml_mfp == NULL)
206 {
Bram Moolenaar9a846fb2022-01-01 21:59:18 +0000207 emsg(_(e_cannot_add_text_property_to_unloaded_buffer));
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100208 goto theend;
209 }
210
211 if (text != NULL)
212 {
Bram Moolenaar783ef722022-08-01 16:11:06 +0100213 garray_T *gap = &buf->b_textprop_text;
214 char_u *p;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100215
216 // double check we got the right ID
217 if (-id - 1 != gap->ga_len)
218 iemsg("text prop ID mismatch");
219 if (gap->ga_growsize == 0)
220 ga_init2(gap, sizeof(char *), 50);
221 if (ga_grow(gap, 1) == FAIL)
222 goto theend;
223 ((char_u **)gap->ga_data)[gap->ga_len++] = text;
Bram Moolenaar783ef722022-08-01 16:11:06 +0100224
Bram Moolenaarf4ba8bc2022-08-05 17:05:04 +0100225 // change any control character (Tab, Newline, etc.) to a Space to make
226 // it simpler to compute the size
Bram Moolenaar783ef722022-08-01 16:11:06 +0100227 for (p = text; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaarf4ba8bc2022-08-05 17:05:04 +0100228 if (*p < ' ')
Bram Moolenaar783ef722022-08-01 16:11:06 +0100229 *p = ' ';
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100230 text = NULL;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200231 }
232
233 for (lnum = start_lnum; lnum <= end_lnum; ++lnum)
234 {
Bram Moolenaar6eda17d2022-09-12 19:25:11 +0100235 colnr_T col; // start column use in tp_col
236 colnr_T sort_col; // column where it appears
237 long length; // in bytes
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200238
239 // Fetch the line to get the ml_line_len field updated.
240 proplen = get_text_props(buf, lnum, &props, TRUE);
241 textlen = buf->b_ml.ml_line_len - proplen * sizeof(textprop_T);
242
243 if (lnum == start_lnum)
244 col = start_col;
245 else
246 col = 1;
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100247 if (col - 1 > (colnr_T)textlen && !(col == 0 && text_arg != NULL))
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200248 {
Bram Moolenaar8dac2ac2021-12-27 20:57:06 +0000249 semsg(_(e_invalid_column_number_nr), (long)start_col);
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100250 goto theend;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200251 }
Bram Moolenaar6eda17d2022-09-12 19:25:11 +0100252 sort_col = col;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200253
254 if (lnum == end_lnum)
255 length = end_col - col;
256 else
257 length = (int)textlen - col + 1;
258 if (length > (long)textlen)
259 length = (int)textlen; // can include the end-of-line
260 if (length < 0)
261 length = 0; // zero-width property
262
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100263 if (text_arg != NULL)
264 {
265 length = 1; // text is placed on one character
266 if (col == 0)
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100267 {
Bram Moolenaar6eda17d2022-09-12 19:25:11 +0100268 col = MAXCOL; // before or after the line
269 if ((text_flags & TP_FLAG_ALIGN_ABOVE) == 0)
270 sort_col = MAXCOL;
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100271 length += text_padding_left;
272 }
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100273 }
274
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200275 // Allocate the new line with space for the new property.
276 newtext = alloc(buf->b_ml.ml_line_len + sizeof(textprop_T));
277 if (newtext == NULL)
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100278 goto theend;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200279 // Copy the text, including terminating NUL.
280 mch_memmove(newtext, buf->b_ml.ml_line_ptr, textlen);
281
282 // Find the index where to insert the new property.
283 // Since the text properties are not aligned properly when stored with
284 // the text, we need to copy them as bytes before using it as a struct.
285 for (i = 0; i < proplen; ++i)
286 {
Bram Moolenaar6eda17d2022-09-12 19:25:11 +0100287 colnr_T prop_col;
288
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200289 mch_memmove(&tmp_prop, props + i * sizeof(textprop_T),
290 sizeof(textprop_T));
Bram Moolenaar6eda17d2022-09-12 19:25:11 +0100291 // col is MAXCOL when the text goes above or after the line, when
292 // above we should use column zero for sorting
293 prop_col = (tmp_prop.tp_flags & TP_FLAG_ALIGN_ABOVE)
294 ? 0 : tmp_prop.tp_col;
295 if (prop_col >= sort_col)
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200296 break;
297 }
298 newprops = newtext + textlen;
299 if (i > 0)
300 mch_memmove(newprops, props, sizeof(textprop_T) * i);
301
302 tmp_prop.tp_col = col;
303 tmp_prop.tp_len = length;
304 tmp_prop.tp_id = id;
305 tmp_prop.tp_type = type->pt_id;
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100306 tmp_prop.tp_flags = text_flags
307 | (lnum > start_lnum ? TP_FLAG_CONT_PREV : 0)
Bram Moolenaar28c9f892022-08-14 13:28:55 +0100308 | (lnum < end_lnum ? TP_FLAG_CONT_NEXT : 0)
309 | ((type->pt_flags & PT_FLAG_INS_START_INCL)
310 ? TP_FLAG_START_INCL : 0);
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200311 tmp_prop.tp_padleft = text_padding_left;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200312 mch_memmove(newprops + i * sizeof(textprop_T), &tmp_prop,
313 sizeof(textprop_T));
314
315 if (i < proplen)
316 mch_memmove(newprops + (i + 1) * sizeof(textprop_T),
317 props + i * sizeof(textprop_T),
318 sizeof(textprop_T) * (proplen - i));
319
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100320 if (buf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200321 vim_free(buf->b_ml.ml_line_ptr);
322 buf->b_ml.ml_line_ptr = newtext;
323 buf->b_ml.ml_line_len += sizeof(textprop_T);
324 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
325 }
326
Bram Moolenaar326c5d32022-08-12 13:05:49 +0100327 changed_line_display_buf(buf);
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200328 changed_lines_buf(buf, start_lnum, end_lnum + 1, 0);
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100329 res = OK;
330
331theend:
332 vim_free(text);
333 return res;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200334}
335
336/*
337 * prop_add_list()
338 * First argument specifies the text property:
339 * {'type': <str>, 'id': <num>, 'bufnr': <num>}
340 * Second argument is a List where each item is a List with the following
341 * entries: [lnum, start_col, end_col]
342 */
343 void
344f_prop_add_list(typval_T *argvars, typval_T *rettv UNUSED)
345{
346 dict_T *dict;
347 char_u *type_name;
348 buf_T *buf = curbuf;
349 int id = 0;
350 listitem_T *li;
351 list_T *pos_list;
352 linenr_T start_lnum;
353 colnr_T start_col;
354 linenr_T end_lnum;
355 colnr_T end_col;
356 int error = FALSE;
Bram Moolenaar4997f2a2022-10-13 14:00:45 +0100357 int prev_did_emsg = did_emsg;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200358
359 if (check_for_dict_arg(argvars, 0) == FAIL
360 || check_for_list_arg(argvars, 1) == FAIL)
361 return;
362
Bram Moolenaard83392a2022-09-01 12:22:46 +0100363 if (check_for_nonnull_list_arg(argvars, 1) == FAIL)
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200364 return;
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200365
366 dict = argvars[0].vval.v_dict;
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100367 if (dict == NULL || !dict_has_key(dict, "type"))
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200368 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000369 emsg(_(e_missing_property_type_name));
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200370 return;
371 }
Bram Moolenaard61efa52022-07-23 09:52:04 +0100372 type_name = dict_get_string(dict, "type", FALSE);
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200373
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100374 if (dict_has_key(dict, "id"))
Bram Moolenaard61efa52022-07-23 09:52:04 +0100375 id = dict_get_number(dict, "id");
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200376
377 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
378 return;
379
Paul Ollis4c3d21a2022-05-24 21:26:37 +0100380 // This must be done _before_ we start adding properties because property
381 // changes trigger buffer (memline) reorganisation, which needs this flag
382 // to be correctly set.
383 buf->b_has_textprop = TRUE; // this is never reset
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200384 FOR_ALL_LIST_ITEMS(argvars[1].vval.v_list, li)
385 {
386 if (li->li_tv.v_type != VAR_LIST || li->li_tv.vval.v_list == NULL)
387 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000388 emsg(_(e_list_required));
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200389 return;
390 }
391
392 pos_list = li->li_tv.vval.v_list;
393 start_lnum = list_find_nr(pos_list, 0L, &error);
Bram Moolenaar4997f2a2022-10-13 14:00:45 +0100394 if (!error)
395 start_col = list_find_nr(pos_list, 1L, &error);
396 if (!error)
397 end_lnum = list_find_nr(pos_list, 2L, &error);
398 if (!error)
399 end_col = list_find_nr(pos_list, 3L, &error);
Bram Moolenaard93009e2022-10-13 14:35:24 +0100400 int this_id = id;
401 if (!error && pos_list->lv_len > 4)
402 this_id = list_find_nr(pos_list, 4L, &error);
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200403 if (error || start_lnum <= 0 || start_col <= 0
Bram Moolenaar4997f2a2022-10-13 14:00:45 +0100404 || end_lnum <= 0 || end_col <= 0)
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200405 {
Bram Moolenaar4997f2a2022-10-13 14:00:45 +0100406 if (prev_did_emsg == did_emsg)
407 emsg(_(e_invalid_argument));
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200408 return;
409 }
Bram Moolenaard93009e2022-10-13 14:35:24 +0100410 if (prop_add_one(buf, type_name, this_id, NULL, 0, 0,
411 start_lnum, end_lnum, start_col, end_col) == FAIL)
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200412 return;
413 }
414
Bram Moolenaara4d158b2022-08-14 14:17:45 +0100415 redraw_buf_later(buf, UPD_VALID);
Yegappan Lakshmananccfb7c62021-08-16 21:39:09 +0200416}
417
418/*
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100419 * Get the next ID to use for a textprop with text in buffer "buf".
420 */
421 static int
422get_textprop_id(buf_T *buf)
423{
424 // TODO: recycle deleted entries
425 return -(buf->b_textprop_text.ga_len + 1);
426}
427
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000428// Flag that is set when a negative ID isused for a normal text property.
429// It is then impossible to use virtual text properties.
430static int did_use_negative_pop_id = FALSE;
431
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100432/*
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200433 * Shared between prop_add() and popup_create().
434 * "dict_arg" is the function argument of a dict containing "bufnr".
435 * it is NULL for popup_create().
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100436 * Returns the "id" used for "text" or zero.
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200437 */
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100438 int
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200439prop_add_common(
440 linenr_T start_lnum,
441 colnr_T start_col,
442 dict_T *dict,
443 buf_T *default_buf,
444 typval_T *dict_arg)
445{
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200446 linenr_T end_lnum;
447 colnr_T end_col;
448 char_u *type_name;
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200449 buf_T *buf = default_buf;
450 int id = 0;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100451 char_u *text = NULL;
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100452 int text_padding_left = 0;
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100453 int flags = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100454
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100455 if (dict == NULL || !dict_has_key(dict, "type"))
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100456 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000457 emsg(_(e_missing_property_type_name));
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100458 goto theend;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100459 }
Bram Moolenaard61efa52022-07-23 09:52:04 +0100460 type_name = dict_get_string(dict, "type", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100461
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100462 if (dict_has_key(dict, "end_lnum"))
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100463 {
Bram Moolenaard61efa52022-07-23 09:52:04 +0100464 end_lnum = dict_get_number(dict, "end_lnum");
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100465 if (end_lnum < start_lnum)
466 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000467 semsg(_(e_invalid_value_for_argument_str), "end_lnum");
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100468 goto theend;
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100469 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100470 }
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100471 else
472 end_lnum = start_lnum;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100473
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100474 if (dict_has_key(dict, "length"))
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100475 {
Bram Moolenaard61efa52022-07-23 09:52:04 +0100476 long length = dict_get_number(dict, "length");
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100477
Bram Moolenaarb9c67a52019-01-01 19:49:20 +0100478 if (length < 0 || end_lnum > start_lnum)
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100479 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000480 semsg(_(e_invalid_value_for_argument_str), "length");
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100481 goto theend;
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100482 }
Bram Moolenaarb9c67a52019-01-01 19:49:20 +0100483 end_col = start_col + length;
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100484 }
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100485 else if (dict_has_key(dict, "end_col"))
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100486 {
Bram Moolenaard61efa52022-07-23 09:52:04 +0100487 end_col = dict_get_number(dict, "end_col");
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100488 if (end_col <= 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100489 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000490 semsg(_(e_invalid_value_for_argument_str), "end_col");
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100491 goto theend;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100492 }
493 }
Bram Moolenaare3d31b02018-12-24 23:07:04 +0100494 else if (start_lnum == end_lnum)
495 end_col = start_col;
496 else
497 end_col = 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100498
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +0100499 if (dict_has_key(dict, "id"))
Bram Moolenaard61efa52022-07-23 09:52:04 +0100500 id = dict_get_number(dict, "id");
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100501
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100502 if (dict_has_key(dict, "text"))
503 {
Bram Moolenaarfb593c52022-09-17 18:57:36 +0100504 if (dict_has_key(dict, "length")
505 || dict_has_key(dict, "end_col")
506 || dict_has_key(dict, "end_lnum"))
507 {
508 emsg(_(e_cannot_use_length_endcol_and_endlnum_with_text));
509 goto theend;
510 }
511
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100512 text = dict_get_string(dict, "text", TRUE);
513 if (text == NULL)
514 goto theend;
515 // use a default length of 1 to make multiple props show up
516 end_col = start_col + 1;
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100517
518 if (dict_has_key(dict, "text_align"))
519 {
520 char_u *p = dict_get_string(dict, "text_align", FALSE);
521
522 if (p == NULL)
523 goto theend;
Bram Moolenaar82b14c12022-08-10 19:50:47 +0100524 if (start_col != 0)
525 {
526 emsg(_(e_can_only_use_text_align_when_column_is_zero));
527 goto theend;
528 }
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100529 if (STRCMP(p, "right") == 0)
530 flags |= TP_FLAG_ALIGN_RIGHT;
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100531 else if (STRCMP(p, "above") == 0)
532 flags |= TP_FLAG_ALIGN_ABOVE;
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100533 else if (STRCMP(p, "below") == 0)
534 flags |= TP_FLAG_ALIGN_BELOW;
535 else if (STRCMP(p, "after") != 0)
536 {
537 semsg(_(e_invalid_value_for_argument_str_str), "text_align", p);
538 goto theend;
539 }
540 }
541
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100542 if (dict_has_key(dict, "text_padding_left"))
543 {
544 text_padding_left = dict_get_number(dict, "text_padding_left");
545 if (text_padding_left < 0)
546 {
547 semsg(_(e_argument_must_be_positive_str), "text_padding_left");
548 goto theend;
549 }
550 }
551
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100552 if (dict_has_key(dict, "text_wrap"))
553 {
554 char_u *p = dict_get_string(dict, "text_wrap", FALSE);
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100555
Bram Moolenaarb7963df2022-07-31 17:12:43 +0100556 if (p == NULL)
557 goto theend;
558 if (STRCMP(p, "wrap") == 0)
559 flags |= TP_FLAG_WRAP;
560 else if (STRCMP(p, "truncate") != 0)
561 {
562 semsg(_(e_invalid_value_for_argument_str_str), "text_wrap", p);
563 goto theend;
564 }
565 }
566 }
567
568 // Column must be 1 or more for a normal text property; when "text" is
569 // present zero means it goes after the line.
570 if (start_col < (text == NULL ? 1 : 0))
571 {
572 semsg(_(e_invalid_column_number_nr), (long)start_col);
573 goto theend;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100574 }
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100575 if (start_col > 0 && text_padding_left > 0)
576 {
577 emsg(_(e_can_only_use_left_padding_when_column_is_zero));
578 goto theend;
579 }
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100580
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200581 if (dict_arg != NULL && get_bufnr_from_arg(dict_arg, &buf) == FAIL)
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100582 goto theend;
583
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000584 if (id < 0)
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100585 {
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000586 if (buf->b_textprop_text.ga_len > 0)
587 {
588 emsg(_(e_cannot_use_negative_id_after_adding_textprop_with_text));
589 goto theend;
590 }
591 did_use_negative_pop_id = TRUE;
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100592 }
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000593
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100594 if (text != NULL)
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000595 {
596 if (did_use_negative_pop_id)
597 {
598 emsg(_(e_cannot_add_textprop_with_text_after_using_textprop_with_negative_id));
599 goto theend;
600 }
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100601 id = get_textprop_id(buf);
Bram Moolenaar4ce1f992022-12-19 13:31:06 +0000602 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100603
Paul Ollis4c3d21a2022-05-24 21:26:37 +0100604 // This must be done _before_ we add the property because property changes
605 // trigger buffer (memline) reorganisation, which needs this flag to be
606 // correctly set.
607 buf->b_has_textprop = TRUE; // this is never reset
608
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100609 prop_add_one(buf, type_name, id, text, text_padding_left, flags,
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100610 start_lnum, end_lnum, start_col, end_col);
611 text = NULL;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100612
Bram Moolenaara4d158b2022-08-14 14:17:45 +0100613 redraw_buf_later(buf, UPD_VALID);
Bram Moolenaar7f9969c2022-07-25 18:13:54 +0100614
615theend:
616 vim_free(text);
617 return id;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100618}
619
620/*
Bram Moolenaarfb95e212018-12-14 12:18:11 +0100621 * Fetch the text properties for line "lnum" in buffer "buf".
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100622 * Returns the number of text properties and, when non-zero, a pointer to the
623 * first one in "props" (note that it is not aligned, therefore the char_u
624 * pointer).
625 */
626 int
627get_text_props(buf_T *buf, linenr_T lnum, char_u **props, int will_change)
628{
629 char_u *text;
630 size_t textlen;
631 size_t proplen;
632
Christian Brabandt0d0b3b12023-12-03 17:56:43 +0100633 // Be quick when no text property types have been defined for the buffer,
Bram Moolenaarb413d2e2018-12-25 23:15:46 +0100634 // unless we are adding one.
Bram Moolenaard79eef22019-05-24 20:41:55 +0200635 if ((!buf->b_has_textprop && !will_change) || buf->b_ml.ml_mfp == NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100636 return 0;
637
638 // Fetch the line to get the ml_line_len field updated.
639 text = ml_get_buf(buf, lnum, will_change);
640 textlen = STRLEN(text) + 1;
641 proplen = buf->b_ml.ml_line_len - textlen;
Bram Moolenaar38ea2732022-08-07 22:04:56 +0100642 if (proplen == 0)
643 return 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100644 if (proplen % sizeof(textprop_T) != 0)
645 {
RestorerZ68ebcee2023-05-31 17:12:14 +0100646 iemsg(e_text_property_info_corrupted);
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100647 return 0;
648 }
Bram Moolenaar38ea2732022-08-07 22:04:56 +0100649 *props = text + textlen;
Bram Moolenaar4efe73b2018-12-16 14:37:39 +0100650 return (int)(proplen / sizeof(textprop_T));
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100651}
652
Bram Moolenaar4d91d342022-08-06 13:48:20 +0100653/*
Bram Moolenaarc9dc03f2022-09-12 17:51:07 +0100654 * Return the number of text properties with "above" or "below" alignment in
655 * line "lnum". A "right" aligned property also goes below after a "below" or
656 * other "right" aligned property.
Bram Moolenaar4d91d342022-08-06 13:48:20 +0100657 */
658 int
Bram Moolenaarc9dc03f2022-09-12 17:51:07 +0100659prop_count_above_below(buf_T *buf, linenr_T lnum)
Bram Moolenaar4d91d342022-08-06 13:48:20 +0100660{
661 char_u *props;
662 int count = get_text_props(buf, lnum, &props, FALSE);
663 int result = 0;
664 textprop_T prop;
665 int i;
Bram Moolenaar8f369fb2022-08-13 19:35:05 +0100666 int next_right_goes_below = FALSE;
Bram Moolenaar4d91d342022-08-06 13:48:20 +0100667
668 if (count == 0)
669 return 0;
670 for (i = 0; i < count; ++i)
671 {
672 mch_memmove(&prop, props + i * sizeof(prop), sizeof(prop));
Bram Moolenaar89469d12022-12-02 20:46:26 +0000673 if (prop.tp_col == MAXCOL && text_prop_type_valid(buf, &prop))
Bram Moolenaar8f369fb2022-08-13 19:35:05 +0100674 {
675 if ((prop.tp_flags & TP_FLAG_ALIGN_BELOW)
676 || (next_right_goes_below
677 && (prop.tp_flags & TP_FLAG_ALIGN_RIGHT)))
678 {
679 next_right_goes_below = TRUE;
680 ++result;
681 }
Bram Moolenaarc9dc03f2022-09-12 17:51:07 +0100682 else if (prop.tp_flags & TP_FLAG_ALIGN_ABOVE)
683 {
684 next_right_goes_below = FALSE;
685 ++result;
686 }
Bram Moolenaar8f369fb2022-08-13 19:35:05 +0100687 else if (prop.tp_flags & TP_FLAG_ALIGN_RIGHT)
688 next_right_goes_below = TRUE;
689 }
Bram Moolenaar4d91d342022-08-06 13:48:20 +0100690 }
691 return result;
692}
693
Bram Moolenaar87be9be2020-05-30 15:32:02 +0200694/**
695 * Return the number of text properties on line "lnum" in the current buffer.
696 * When "only_starting" is true only text properties starting in this line will
697 * be considered.
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +0100698 * When "last_line" is FALSE then text properties after the line are not
699 * counted.
Bram Moolenaar87be9be2020-05-30 15:32:02 +0200700 */
701 int
Bram Moolenaare175dc62022-08-01 22:18:50 +0100702count_props(linenr_T lnum, int only_starting, int last_line)
Bram Moolenaar87be9be2020-05-30 15:32:02 +0200703{
704 char_u *props;
705 int proplen = get_text_props(curbuf, lnum, &props, 0);
706 int result = proplen;
707 int i;
708 textprop_T prop;
709
Bram Moolenaare175dc62022-08-01 22:18:50 +0100710 for (i = 0; i < proplen; ++i)
711 {
712 mch_memmove(&prop, props + i * sizeof(prop), sizeof(prop));
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +0100713 // A prop is dropped when in the first line and it continues from the
Bram Moolenaare175dc62022-08-01 22:18:50 +0100714 // previous line, or when not in the last line and it is virtual text
715 // after the line.
716 if ((only_starting && (prop.tp_flags & TP_FLAG_CONT_PREV))
Christian Brabandt0d0b3b12023-12-03 17:56:43 +0100717 || (!last_line && prop.tp_col == MAXCOL))
Bram Moolenaare175dc62022-08-01 22:18:50 +0100718 --result;
719 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +0200720 return result;
721}
722
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100723static textprop_T *text_prop_compare_props;
724static buf_T *text_prop_compare_buf;
725
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +0000726/*
727 * Score for sorting on position of the text property: 0: above,
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100728 * 1: after (default), 2: right, 3: below (comes last)
729 */
730 static int
731text_prop_order(int flags)
732{
733 if (flags & TP_FLAG_ALIGN_ABOVE)
734 return 0;
735 if (flags & TP_FLAG_ALIGN_RIGHT)
736 return 2;
737 if (flags & TP_FLAG_ALIGN_BELOW)
738 return 3;
739 return 1;
740}
741
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100742/*
743 * Function passed to qsort() to sort text properties.
744 * Return 1 if "s1" has priority over "s2", -1 if the other way around, zero if
745 * both have the same priority.
746 */
747 static int
748text_prop_compare(const void *s1, const void *s2)
749{
750 int idx1, idx2;
751 textprop_T *tp1, *tp2;
752 proptype_T *pt1, *pt2;
753 colnr_T col1, col2;
754
755 idx1 = *(int *)s1;
756 idx2 = *(int *)s2;
757 tp1 = &text_prop_compare_props[idx1];
758 tp2 = &text_prop_compare_props[idx2];
759 col1 = tp1->tp_col;
760 col2 = tp2->tp_col;
zeertzjqce53e3e2023-09-01 18:49:30 +0200761 if (col1 == MAXCOL || col2 == MAXCOL)
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100762 {
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100763 int order1 = text_prop_order(tp1->tp_flags);
764 int order2 = text_prop_order(tp2->tp_flags);
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100765
zeertzjqce53e3e2023-09-01 18:49:30 +0200766 // sort on order where it is added
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100767 if (order1 != order2)
768 return order1 < order2 ? 1 : -1;
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100769 }
770
771 // property that inserts text has priority over one that doesn't
772 if ((tp1->tp_id < 0) != (tp2->tp_id < 0))
773 return tp1->tp_id < 0 ? 1 : -1;
774
775 // check highest priority, defined by the type
776 pt1 = text_prop_type_by_id(text_prop_compare_buf, tp1->tp_type);
777 pt2 = text_prop_type_by_id(text_prop_compare_buf, tp2->tp_type);
778 if (pt1 != pt2)
779 {
780 if (pt1 == NULL)
781 return -1;
782 if (pt2 == NULL)
783 return 1;
784 if (pt1->pt_priority != pt2->pt_priority)
785 return pt1->pt_priority > pt2->pt_priority ? 1 : -1;
786 }
787
788 // same priority, one that starts first wins
789 if (col1 != col2)
790 return col1 < col2 ? 1 : -1;
791
792 // for a property with text the id can be used as tie breaker
793 if (tp1->tp_id < 0)
794 return tp1->tp_id > tp2->tp_id ? 1 : -1;
795
796 return 0;
797}
798
799/*
800 * Sort "count" text properties using an array if indexes "idxs" into the list
801 * of text props "props" for buffer "buf".
802 */
803 void
804sort_text_props(
805 buf_T *buf,
806 textprop_T *props,
807 int *idxs,
808 int count)
809{
810 text_prop_compare_buf = buf;
811 text_prop_compare_props = props;
812 qsort((void *)idxs, (size_t)count, sizeof(int), text_prop_compare);
813}
814
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100815/*
Bram Moolenaar12034e22019-08-25 22:25:02 +0200816 * Find text property "type_id" in the visible lines of window "wp".
817 * Match "id" when it is > 0.
818 * Returns FAIL when not found.
819 */
820 int
Bram Moolenaar89469d12022-12-02 20:46:26 +0000821find_visible_prop(
822 win_T *wp,
823 int type_id,
824 int id,
825 textprop_T *prop,
826 linenr_T *found_lnum)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200827{
Bram Moolenaar89469d12022-12-02 20:46:26 +0000828 // return when "type_id" no longer exists
829 if (text_prop_type_by_id(wp->w_buffer, type_id) == NULL)
830 return FAIL;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200831
832 // w_botline may not have been updated yet.
Bram Moolenaar23999d72020-12-23 14:36:00 +0100833 validate_botline_win(wp);
Bram Moolenaar89469d12022-12-02 20:46:26 +0000834 for (linenr_T lnum = wp->w_topline; lnum < wp->w_botline; ++lnum)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200835 {
Bram Moolenaar89469d12022-12-02 20:46:26 +0000836 char_u *props;
837 int count = get_text_props(wp->w_buffer, lnum, &props, FALSE);
838 for (int i = 0; i < count; ++i)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200839 {
840 mch_memmove(prop, props + i * sizeof(textprop_T),
841 sizeof(textprop_T));
842 if (prop->tp_type == type_id && (id <= 0 || prop->tp_id == id))
843 {
844 *found_lnum = lnum;
845 return OK;
846 }
847 }
848 }
849 return FAIL;
850}
851
852/*
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100853 * Set the text properties for line "lnum" to "props" with length "len".
854 * If "len" is zero text properties are removed, "props" is not used.
855 * Any existing text properties are dropped.
856 * Only works for the current buffer.
857 */
858 static void
859set_text_props(linenr_T lnum, char_u *props, int len)
860{
Bram Moolenaar8aef43b2019-01-08 20:14:35 +0100861 char_u *text;
862 char_u *newtext;
863 int textlen;
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100864
865 text = ml_get(lnum);
Bram Moolenaar8aef43b2019-01-08 20:14:35 +0100866 textlen = (int)STRLEN(text) + 1;
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100867 newtext = alloc(textlen + len);
868 if (newtext == NULL)
869 return;
870 mch_memmove(newtext, text, textlen);
871 if (len > 0)
872 mch_memmove(newtext + textlen, props, len);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100873 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100874 vim_free(curbuf->b_ml.ml_line_ptr);
875 curbuf->b_ml.ml_line_ptr = newtext;
876 curbuf->b_ml.ml_line_len = textlen + len;
877 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
878}
879
Bram Moolenaar213bbaf2022-08-05 19:46:48 +0100880/*
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +0100881 * Add "text_props" with "text_prop_count" text properties to line "lnum".
Bram Moolenaar213bbaf2022-08-05 19:46:48 +0100882 */
883 void
884add_text_props(linenr_T lnum, textprop_T *text_props, int text_prop_count)
885{
886 char_u *text;
887 char_u *newtext;
888 int proplen = text_prop_count * (int)sizeof(textprop_T);
889
890 text = ml_get(lnum);
891 newtext = alloc(curbuf->b_ml.ml_line_len + proplen);
892 if (newtext == NULL)
893 return;
894 mch_memmove(newtext, text, curbuf->b_ml.ml_line_len);
895 mch_memmove(newtext + curbuf->b_ml.ml_line_len, text_props, proplen);
896 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
897 vim_free(curbuf->b_ml.ml_line_ptr);
898 curbuf->b_ml.ml_line_ptr = newtext;
899 curbuf->b_ml.ml_line_len += proplen;
900 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
901}
902
Bram Moolenaare44336b2022-08-07 18:20:08 +0100903/*
904 * Function passed to qsort() for sorting proptype_T on pt_id.
905 */
906 static int
907compare_pt(const void *s1, const void *s2)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100908{
Bram Moolenaare44336b2022-08-07 18:20:08 +0100909 proptype_T *tp1 = *(proptype_T **)s1;
910 proptype_T *tp2 = *(proptype_T **)s2;
911
912 return tp1->pt_id == tp2->pt_id ? 0 : tp1->pt_id < tp2->pt_id ? -1 : 1;
913}
914
915 static proptype_T *
916find_type_by_id(hashtab_T *ht, proptype_T ***array, int id)
917{
918 int low = 0;
919 int high;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100920
Bram Moolenaar10246902022-08-08 17:08:05 +0100921 if (ht == NULL || ht->ht_used == 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100922 return NULL;
923
dundargocc57b5bc2022-11-02 13:30:51 +0000924 // Make the lookup faster by creating an array with pointers to
Bram Moolenaare44336b2022-08-07 18:20:08 +0100925 // hashtable entries, sorted on pt_id.
926 if (*array == NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100927 {
Bram Moolenaare44336b2022-08-07 18:20:08 +0100928 long todo;
929 hashitem_T *hi;
930 int i = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100931
Bram Moolenaare44336b2022-08-07 18:20:08 +0100932 *array = ALLOC_MULT(proptype_T *, ht->ht_used);
933 if (*array == NULL)
934 return NULL;
935 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +0000936 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaare44336b2022-08-07 18:20:08 +0100937 {
938 if (!HASHITEM_EMPTY(hi))
939 {
940 (*array)[i++] = HI2PT(hi);
941 --todo;
942 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100943 }
Bram Moolenaare44336b2022-08-07 18:20:08 +0100944 qsort((void *)*array, ht->ht_used, sizeof(proptype_T *), compare_pt);
945 }
946
947 // binary search in the sorted array
948 high = ht->ht_used;
949 while (high > low)
950 {
951 int m = (high + low) / 2;
952
953 if ((*array)[m]->pt_id == id)
954 return (*array)[m];
955 if ((*array)[m]->pt_id > id)
956 high = m;
957 else
958 low = m + 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100959 }
960 return NULL;
961}
962
963/*
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100964 * Fill 'dict' with text properties in 'prop'.
965 */
966 static void
967prop_fill_dict(dict_T *dict, textprop_T *prop, buf_T *buf)
968{
969 proptype_T *pt;
Martin Tournoije2390c72021-07-28 13:30:16 +0200970 int buflocal = TRUE;
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200971 int virtualtext_prop = prop->tp_id < 0;
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100972
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200973 dict_add_number(dict, "col", (prop->tp_col == MAXCOL) ? 0 : prop->tp_col);
974 if (!virtualtext_prop)
975 {
976 dict_add_number(dict, "length", prop->tp_len);
977 dict_add_number(dict, "id", prop->tp_id);
978 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100979 dict_add_number(dict, "start", !(prop->tp_flags & TP_FLAG_CONT_PREV));
980 dict_add_number(dict, "end", !(prop->tp_flags & TP_FLAG_CONT_NEXT));
Martin Tournoije2390c72021-07-28 13:30:16 +0200981
Bram Moolenaare44336b2022-08-07 18:20:08 +0100982 pt = find_type_by_id(buf->b_proptypes, &buf->b_proparray, prop->tp_type);
Martin Tournoije2390c72021-07-28 13:30:16 +0200983 if (pt == NULL)
984 {
Bram Moolenaare44336b2022-08-07 18:20:08 +0100985 pt = find_type_by_id(global_proptypes, &global_proparray,
986 prop->tp_type);
Martin Tournoije2390c72021-07-28 13:30:16 +0200987 buflocal = FALSE;
988 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100989 if (pt != NULL)
990 dict_add_string(dict, "type", pt->pt_name);
Martin Tournoije2390c72021-07-28 13:30:16 +0200991
992 if (buflocal)
993 dict_add_number(dict, "type_bufnr", buf->b_fnum);
994 else
995 dict_add_number(dict, "type_bufnr", 0);
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200996 if (virtualtext_prop)
Yegappan Lakshmananf9037f12023-08-20 18:27:45 +0200997 {
998 // virtual text property
999 garray_T *gap = &buf->b_textprop_text;
1000 char_u *text;
1001
1002 // negate the property id to get the string index
1003 text = ((char_u **)gap->ga_data)[-prop->tp_id - 1];
1004 dict_add_string(dict, "text", text);
1005
1006 // text_align
1007 char_u *text_align = NULL;
1008 if (prop->tp_flags & TP_FLAG_ALIGN_RIGHT)
1009 text_align = (char_u *)"right";
1010 else if (prop->tp_flags & TP_FLAG_ALIGN_ABOVE)
1011 text_align = (char_u *)"above";
1012 else if (prop->tp_flags & TP_FLAG_ALIGN_BELOW)
1013 text_align = (char_u *)"below";
1014 if (text_align != NULL)
1015 dict_add_string(dict, "text_align", text_align);
1016
1017 // text_wrap
1018 if (prop->tp_flags & TP_FLAG_WRAP)
1019 dict_add_string(dict, "text_wrap", (char_u *)"wrap");
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +02001020 if (prop->tp_padleft != 0)
1021 dict_add_number(dict, "text_padding_left", prop->tp_padleft);
Yegappan Lakshmananf9037f12023-08-20 18:27:45 +02001022 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001023}
1024
1025/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001026 * Find a property type by ID in "buf" or globally.
1027 * Returns NULL if not found.
1028 */
1029 proptype_T *
1030text_prop_type_by_id(buf_T *buf, int id)
1031{
1032 proptype_T *type;
1033
Bram Moolenaare44336b2022-08-07 18:20:08 +01001034 type = find_type_by_id(buf->b_proptypes, &buf->b_proparray, id);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001035 if (type == NULL)
Bram Moolenaare44336b2022-08-07 18:20:08 +01001036 type = find_type_by_id(global_proptypes, &global_proparray, id);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001037 return type;
1038}
1039
1040/*
Bram Moolenaar89469d12022-12-02 20:46:26 +00001041 * Return TRUE if "prop" is a valid text property type.
1042 */
1043 int
1044text_prop_type_valid(buf_T *buf, textprop_T *prop)
1045{
1046 return text_prop_type_by_id(buf, prop->tp_type) != NULL;
1047}
1048
1049/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001050 * prop_clear({lnum} [, {lnum_end} [, {bufnr}]])
1051 */
1052 void
1053f_prop_clear(typval_T *argvars, typval_T *rettv UNUSED)
1054{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001055 linenr_T start;
1056 linenr_T end;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001057 linenr_T lnum;
1058 buf_T *buf = curbuf;
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001059 int did_clear = FALSE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001060
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001061 if (in_vim9script()
1062 && (check_for_number_arg(argvars, 0) == FAIL
1063 || check_for_opt_number_arg(argvars, 1) == FAIL
1064 || (argvars[1].v_type != VAR_UNKNOWN
1065 && check_for_opt_dict_arg(argvars, 2) == FAIL)))
1066 return;
1067
1068 start = tv_get_number(&argvars[0]);
1069 end = start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001070 if (argvars[1].v_type != VAR_UNKNOWN)
1071 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001072 end = tv_get_number(&argvars[1]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001073 if (argvars[2].v_type != VAR_UNKNOWN)
1074 {
1075 if (get_bufnr_from_arg(&argvars[2], &buf) == FAIL)
1076 return;
1077 }
1078 }
1079 if (start < 1 || end < 1)
1080 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001081 emsg(_(e_invalid_range));
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001082 return;
1083 }
1084
1085 for (lnum = start; lnum <= end; ++lnum)
1086 {
1087 char_u *text;
1088 size_t len;
1089
1090 if (lnum > buf->b_ml.ml_line_count)
1091 break;
1092 text = ml_get_buf(buf, lnum, FALSE);
1093 len = STRLEN(text) + 1;
1094 if ((size_t)buf->b_ml.ml_line_len > len)
1095 {
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001096 did_clear = TRUE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001097 if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY))
1098 {
1099 char_u *newtext = vim_strsave(text);
1100
1101 // need to allocate the line now
1102 if (newtext == NULL)
1103 return;
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01001104 if (buf->b_ml.ml_flags & ML_ALLOCATED)
1105 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001106 buf->b_ml.ml_line_ptr = newtext;
1107 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
1108 }
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01001109 buf->b_ml.ml_line_len = (int)len;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001110 }
1111 }
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001112 if (did_clear)
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001113 redraw_buf_later(buf, UPD_NOT_VALID);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001114}
1115
1116/*
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001117 * prop_find({props} [, {direction}])
1118 */
1119 void
1120f_prop_find(typval_T *argvars, typval_T *rettv)
1121{
1122 pos_T *cursor = &curwin->w_cursor;
1123 dict_T *dict;
1124 buf_T *buf = curbuf;
1125 dictitem_T *di;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001126 int lnum_start;
1127 int start_pos_has_prop = 0;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001128 int seen_end = FALSE;
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001129 int id = 0;
1130 int id_found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001131 int type_id = -1;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001132 int skipstart = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001133 int lnum = -1;
1134 int col = -1;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001135 int dir = FORWARD; // FORWARD == 1, BACKWARD == -1
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001136 int both;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001137
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001138 if (in_vim9script()
1139 && (check_for_dict_arg(argvars, 0) == FAIL
1140 || check_for_opt_string_arg(argvars, 1) == FAIL))
1141 return;
1142
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001143 if (check_for_nonnull_dict_arg(argvars, 0) == FAIL)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001144 return;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001145 dict = argvars[0].vval.v_dict;
1146
1147 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
1148 return;
1149 if (buf->b_ml.ml_mfp == NULL)
1150 return;
1151
1152 if (argvars[1].v_type != VAR_UNKNOWN)
1153 {
1154 char_u *dir_s = tv_get_string(&argvars[1]);
1155
1156 if (*dir_s == 'b')
LemonBoy9bd3ce22022-04-18 21:54:02 +01001157 dir = BACKWARD;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001158 else if (*dir_s != 'f')
1159 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001160 emsg(_(e_invalid_argument));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001161 return;
1162 }
1163 }
1164
1165 di = dict_find(dict, (char_u *)"lnum", -1);
1166 if (di != NULL)
1167 lnum = tv_get_number(&di->di_tv);
1168
1169 di = dict_find(dict, (char_u *)"col", -1);
1170 if (di != NULL)
1171 col = tv_get_number(&di->di_tv);
1172
1173 if (lnum == -1)
1174 {
1175 lnum = cursor->lnum;
1176 col = cursor->col + 1;
1177 }
1178 else if (col == -1)
1179 col = 1;
1180
1181 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
1182 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001183 emsg(_(e_invalid_range));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001184 return;
1185 }
1186
Bram Moolenaard61efa52022-07-23 09:52:04 +01001187 skipstart = dict_get_bool(dict, "skipstart", 0);
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001188
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001189 if (dict_has_key(dict, "id"))
Bram Moolenaar8e3fc132021-07-31 18:33:57 +02001190 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001191 id = dict_get_number(dict, "id");
Bram Moolenaare041dde2021-08-01 21:30:12 +02001192 id_found = TRUE;
Bram Moolenaar8e3fc132021-07-31 18:33:57 +02001193 }
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001194 if (dict_has_key(dict, "type"))
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001195 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001196 char_u *name = dict_get_string(dict, "type", FALSE);
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001197 proptype_T *type = lookup_prop_type(name, buf);
1198
1199 if (type == NULL)
1200 return;
1201 type_id = type->pt_id;
1202 }
Bram Moolenaard61efa52022-07-23 09:52:04 +01001203 both = dict_get_bool(dict, "both", FALSE);
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001204 if (!id_found && type_id == -1)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001205 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001206 emsg(_(e_need_at_least_one_of_id_or_type));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001207 return;
1208 }
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001209 if (both && (!id_found || type_id == -1))
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001210 {
Ben Jacksona7704222022-08-20 20:54:51 +01001211 emsg(_(e_need_id_and_type_or_types_with_both));
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001212 return;
1213 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001214
1215 lnum_start = lnum;
1216
1217 if (rettv_dict_alloc(rettv) == FAIL)
1218 return;
1219
1220 while (1)
1221 {
1222 char_u *text = ml_get_buf(buf, lnum, FALSE);
1223 size_t textlen = STRLEN(text) + 1;
1224 int count = (int)((buf->b_ml.ml_line_len - textlen)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001225 / sizeof(textprop_T));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001226 int i;
1227 textprop_T prop;
1228 int prop_start;
1229 int prop_end;
1230
LemonBoy9bd3ce22022-04-18 21:54:02 +01001231 for (i = dir == BACKWARD ? count - 1 : 0; i >= 0 && i < count; i += dir)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001232 {
1233 mch_memmove(&prop, text + textlen + i * sizeof(textprop_T),
LemonBoy9bd3ce22022-04-18 21:54:02 +01001234 sizeof(textprop_T));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001235
LemonBoy9bd3ce22022-04-18 21:54:02 +01001236 // For the very first line try to find the first property before or
1237 // after `col`, depending on the search direction.
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001238 if (lnum == lnum_start)
Bram Moolenaar965fd8d2020-03-14 07:46:40 +01001239 {
LemonBoy9bd3ce22022-04-18 21:54:02 +01001240 if (dir == BACKWARD)
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001241 {
LemonBoy9bd3ce22022-04-18 21:54:02 +01001242 if (prop.tp_col > col)
1243 continue;
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001244 }
1245 else if (prop.tp_col + prop.tp_len - (prop.tp_len != 0) < col)
1246 continue;
Bram Moolenaar965fd8d2020-03-14 07:46:40 +01001247 }
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001248 if (both ? prop.tp_id == id && prop.tp_type == type_id
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001249 : (id_found && prop.tp_id == id)
1250 || prop.tp_type == type_id)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001251 {
1252 // Check if the starting position has text props.
Bram Moolenaar66b98852020-03-11 19:15:52 +01001253 if (lnum_start == lnum
1254 && col >= prop.tp_col
1255 && (col <= prop.tp_col + prop.tp_len
1256 - (prop.tp_len != 0)))
1257 start_pos_has_prop = 1;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001258
LemonBoy9bd3ce22022-04-18 21:54:02 +01001259 // The property was not continued from last line, it starts on
1260 // this line.
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001261 prop_start = !(prop.tp_flags & TP_FLAG_CONT_PREV);
LemonBoy9bd3ce22022-04-18 21:54:02 +01001262 // The property does not continue on the next line, it ends on
1263 // this line.
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001264 prop_end = !(prop.tp_flags & TP_FLAG_CONT_NEXT);
LemonBoy9bd3ce22022-04-18 21:54:02 +01001265 if (!prop_start && prop_end && dir == FORWARD)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001266 seen_end = 1;
1267
1268 // Skip lines without the start flag.
1269 if (!prop_start)
1270 {
1271 // Always search backwards for start when search started
1272 // on a prop and we're not skipping.
1273 if (start_pos_has_prop && !skipstart)
LemonBoy9bd3ce22022-04-18 21:54:02 +01001274 dir = BACKWARD;
Bram Moolenaar4da7a252020-09-02 19:59:00 +02001275 continue;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001276 }
1277
1278 // If skipstart is true, skip the prop at start pos (even if
1279 // continued from another line).
1280 if (start_pos_has_prop && skipstart && !seen_end)
1281 {
1282 start_pos_has_prop = 0;
Bram Moolenaar4da7a252020-09-02 19:59:00 +02001283 continue;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001284 }
1285
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001286 prop_fill_dict(rettv->vval.v_dict, &prop, buf);
1287 dict_add_number(rettv->vval.v_dict, "lnum", lnum);
1288
1289 return;
1290 }
1291 }
1292
1293 if (dir > 0)
1294 {
1295 if (lnum >= buf->b_ml.ml_line_count)
1296 break;
1297 lnum++;
1298 }
1299 else
1300 {
1301 if (lnum <= 1)
1302 break;
1303 lnum--;
1304 }
1305 }
1306}
1307
1308/*
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001309 * Returns TRUE if 'type_or_id' is in the 'types_or_ids' list.
1310 */
1311 static int
1312prop_type_or_id_in_list(int *types_or_ids, int len, int type_or_id)
1313{
1314 int i;
1315
1316 for (i = 0; i < len; i++)
1317 if (types_or_ids[i] == type_or_id)
1318 return TRUE;
1319
1320 return FALSE;
1321}
1322
1323/*
1324 * Return all the text properties in line 'lnum' in buffer 'buf' in 'retlist'.
1325 * If 'prop_types' is not NULL, then return only the text properties with
1326 * matching property type in the 'prop_types' array.
1327 * If 'prop_ids' is not NULL, then return only the text properties with
1328 * an identifier in the 'props_ids' array.
1329 * If 'add_lnum' is TRUE, then add the line number also to the text property
1330 * dictionary.
1331 */
1332 static void
1333get_props_in_line(
1334 buf_T *buf,
1335 linenr_T lnum,
1336 int *prop_types,
1337 int prop_types_len,
1338 int *prop_ids,
1339 int prop_ids_len,
1340 list_T *retlist,
1341 int add_lnum)
1342{
1343 char_u *text = ml_get_buf(buf, lnum, FALSE);
1344 size_t textlen = STRLEN(text) + 1;
1345 int count;
1346 int i;
1347 textprop_T prop;
1348
1349 count = (int)((buf->b_ml.ml_line_len - textlen) / sizeof(textprop_T));
1350 for (i = 0; i < count; ++i)
1351 {
1352 mch_memmove(&prop, text + textlen + i * sizeof(textprop_T),
1353 sizeof(textprop_T));
1354 if ((prop_types == NULL
1355 || prop_type_or_id_in_list(prop_types, prop_types_len,
1356 prop.tp_type))
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01001357 && (prop_ids == NULL
1358 || prop_type_or_id_in_list(prop_ids, prop_ids_len,
1359 prop.tp_id)))
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001360 {
1361 dict_T *d = dict_alloc();
1362
1363 if (d == NULL)
1364 break;
1365 prop_fill_dict(d, &prop, buf);
1366 if (add_lnum)
1367 dict_add_number(d, "lnum", lnum);
1368 list_append_dict(retlist, d);
1369 }
1370 }
1371}
1372
1373/*
1374 * Convert a List of property type names into an array of property type
1375 * identifiers. Returns a pointer to the allocated array. Returns NULL on
1376 * error. 'num_types' is set to the number of returned property types.
1377 */
1378 static int *
1379get_prop_types_from_names(list_T *l, buf_T *buf, int *num_types)
1380{
1381 int *prop_types;
1382 listitem_T *li;
1383 int i;
1384 char_u *name;
1385 proptype_T *type;
1386
1387 *num_types = 0;
1388
1389 prop_types = ALLOC_MULT(int, list_len(l));
1390 if (prop_types == NULL)
1391 return NULL;
1392
1393 i = 0;
1394 FOR_ALL_LIST_ITEMS(l, li)
1395 {
1396 if (li->li_tv.v_type != VAR_STRING)
1397 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001398 emsg(_(e_string_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001399 goto errret;
1400 }
1401 name = li->li_tv.vval.v_string;
1402 if (name == NULL)
1403 goto errret;
1404
1405 type = lookup_prop_type(name, buf);
1406 if (type == NULL)
1407 goto errret;
1408 prop_types[i++] = type->pt_id;
1409 }
1410
1411 *num_types = i;
1412 return prop_types;
1413
1414errret:
1415 VIM_CLEAR(prop_types);
1416 return NULL;
1417}
1418
1419/*
1420 * Convert a List of property identifiers into an array of property
1421 * identifiers. Returns a pointer to the allocated array. Returns NULL on
1422 * error. 'num_ids' is set to the number of returned property identifiers.
1423 */
1424 static int *
1425get_prop_ids_from_list(list_T *l, int *num_ids)
1426{
1427 int *prop_ids;
1428 listitem_T *li;
1429 int i;
1430 int id;
1431 int error;
1432
1433 *num_ids = 0;
1434
1435 prop_ids = ALLOC_MULT(int, list_len(l));
1436 if (prop_ids == NULL)
1437 return NULL;
1438
1439 i = 0;
1440 FOR_ALL_LIST_ITEMS(l, li)
1441 {
1442 error = FALSE;
1443 id = tv_get_number_chk(&li->li_tv, &error);
1444 if (error)
1445 goto errret;
1446
1447 prop_ids[i++] = id;
1448 }
1449
1450 *num_ids = i;
1451 return prop_ids;
1452
1453errret:
1454 VIM_CLEAR(prop_ids);
1455 return NULL;
1456}
1457
1458/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001459 * prop_list({lnum} [, {bufnr}])
1460 */
1461 void
1462f_prop_list(typval_T *argvars, typval_T *rettv)
1463{
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001464 linenr_T lnum;
1465 linenr_T start_lnum;
1466 linenr_T end_lnum;
1467 buf_T *buf = curbuf;
1468 int add_lnum = FALSE;
1469 int *prop_types = NULL;
1470 int prop_types_len = 0;
1471 int *prop_ids = NULL;
1472 int prop_ids_len = 0;
1473 list_T *l;
1474 dictitem_T *di;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001475
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001476 if (in_vim9script()
1477 && (check_for_number_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001478 || check_for_opt_dict_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001479 return;
1480
Bram Moolenaar93a10962022-06-16 11:42:09 +01001481 if (rettv_list_alloc(rettv) == FAIL)
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001482 return;
1483
1484 // default: get text properties on current line
1485 start_lnum = tv_get_number(&argvars[0]);
1486 end_lnum = start_lnum;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001487 if (argvars[1].v_type != VAR_UNKNOWN)
1488 {
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001489 dict_T *d;
1490
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001491 if (check_for_dict_arg(argvars, 1) == FAIL)
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001492 return;
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001493 d = argvars[1].vval.v_dict;
1494
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001495 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1496 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001497
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001498 if (d != NULL && (di = dict_find(d, (char_u *)"end_lnum", -1)) != NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001499 {
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001500 if (di->di_tv.v_type != VAR_NUMBER)
1501 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001502 emsg(_(e_number_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001503 return;
1504 }
1505 end_lnum = tv_get_number(&di->di_tv);
1506 if (end_lnum < 0)
1507 // negative end_lnum is used as an offset from the last buffer
1508 // line
1509 end_lnum = buf->b_ml.ml_line_count + end_lnum + 1;
1510 else if (end_lnum > buf->b_ml.ml_line_count)
1511 end_lnum = buf->b_ml.ml_line_count;
1512 add_lnum = TRUE;
1513 }
1514 if (d != NULL && (di = dict_find(d, (char_u *)"types", -1)) != NULL)
1515 {
1516 if (di->di_tv.v_type != VAR_LIST)
1517 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001518 emsg(_(e_list_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001519 return;
1520 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001521
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001522 l = di->di_tv.vval.v_list;
1523 if (l != NULL && list_len(l) > 0)
1524 {
1525 prop_types = get_prop_types_from_names(l, buf, &prop_types_len);
1526 if (prop_types == NULL)
1527 return;
1528 }
1529 }
1530 if (d != NULL && (di = dict_find(d, (char_u *)"ids", -1)) != NULL)
1531 {
1532 if (di->di_tv.v_type != VAR_LIST)
1533 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001534 emsg(_(e_list_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001535 goto errret;
1536 }
1537
1538 l = di->di_tv.vval.v_list;
1539 if (l != NULL && list_len(l) > 0)
1540 {
1541 prop_ids = get_prop_ids_from_list(l, &prop_ids_len);
1542 if (prop_ids == NULL)
1543 goto errret;
1544 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001545 }
1546 }
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001547 if (start_lnum < 1 || start_lnum > buf->b_ml.ml_line_count
1548 || end_lnum < 1 || end_lnum < start_lnum)
1549 emsg(_(e_invalid_range));
1550 else
1551 for (lnum = start_lnum; lnum <= end_lnum; lnum++)
1552 get_props_in_line(buf, lnum, prop_types, prop_types_len,
1553 prop_ids, prop_ids_len,
1554 rettv->vval.v_list, add_lnum);
1555
1556errret:
1557 VIM_CLEAR(prop_types);
1558 VIM_CLEAR(prop_ids);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001559}
1560
1561/*
1562 * prop_remove({props} [, {lnum} [, {lnum_end}]])
1563 */
1564 void
1565f_prop_remove(typval_T *argvars, typval_T *rettv)
1566{
1567 linenr_T start = 1;
1568 linenr_T end = 0;
1569 linenr_T lnum;
Bram Moolenaar965c0442021-05-17 00:22:06 +02001570 linenr_T first_changed = 0;
1571 linenr_T last_changed = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001572 dict_T *dict;
1573 buf_T *buf = curbuf;
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001574 int do_all;
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001575 int id = -MAXCOL;
Ben Jacksona7704222022-08-20 20:54:51 +01001576 int type_id = -1; // for a single "type"
1577 int *type_ids = NULL; // array, for a list of "types", allocated
1578 int num_type_ids = 0; // number of elements in "type_ids"
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001579 int both;
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001580 int did_remove_text = FALSE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001581
1582 rettv->vval.v_number = 0;
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001583
1584 if (in_vim9script()
1585 && (check_for_dict_arg(argvars, 0) == FAIL
1586 || check_for_opt_number_arg(argvars, 1) == FAIL
1587 || (argvars[1].v_type != VAR_UNKNOWN
1588 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1589 return;
1590
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001591 if (check_for_nonnull_dict_arg(argvars, 0) == FAIL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001592 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001593
1594 if (argvars[1].v_type != VAR_UNKNOWN)
1595 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001596 start = tv_get_number(&argvars[1]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001597 end = start;
1598 if (argvars[2].v_type != VAR_UNKNOWN)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001599 end = tv_get_number(&argvars[2]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001600 if (start < 1 || end < 1)
1601 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001602 emsg(_(e_invalid_range));
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001603 return;
1604 }
1605 }
1606
1607 dict = argvars[0].vval.v_dict;
Bram Moolenaarf0884c52019-05-24 21:22:29 +02001608 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
1609 return;
1610 if (buf->b_ml.ml_mfp == NULL)
1611 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001612
Bram Moolenaard61efa52022-07-23 09:52:04 +01001613 do_all = dict_get_bool(dict, "all", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001614
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001615 if (dict_has_key(dict, "id"))
Bram Moolenaard61efa52022-07-23 09:52:04 +01001616 id = dict_get_number(dict, "id");
Ben Jacksona7704222022-08-20 20:54:51 +01001617
1618 // if a specific type was supplied "type": check that (and ignore "types".
1619 // Otherwise check against the list of "types".
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001620 if (dict_has_key(dict, "type"))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001621 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001622 char_u *name = dict_get_string(dict, "type", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001623 proptype_T *type = lookup_prop_type(name, buf);
1624
1625 if (type == NULL)
1626 return;
1627 type_id = type->pt_id;
1628 }
Ben Jacksona7704222022-08-20 20:54:51 +01001629 if (dict_has_key(dict, "types"))
1630 {
1631 typval_T types;
1632 listitem_T *li = NULL;
1633
1634 dict_get_tv(dict, "types", &types);
1635 if (types.v_type == VAR_LIST && types.vval.v_list->lv_len > 0)
1636 {
1637 type_ids = alloc( sizeof(int) * types.vval.v_list->lv_len );
1638
1639 FOR_ALL_LIST_ITEMS(types.vval.v_list, li)
1640 {
1641 proptype_T *prop_type;
1642
1643 if (li->li_tv.v_type != VAR_STRING)
1644 continue;
1645
1646 prop_type = lookup_prop_type(li->li_tv.vval.v_string, buf);
1647
1648 if (!prop_type)
1649 goto cleanup_prop_remove;
1650
1651 type_ids[num_type_ids++] = prop_type->pt_id;
1652 }
1653 }
1654 }
Bram Moolenaard61efa52022-07-23 09:52:04 +01001655 both = dict_get_bool(dict, "both", FALSE);
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001656
Ben Jacksona7704222022-08-20 20:54:51 +01001657 if (id == -MAXCOL && (type_id == -1 && num_type_ids == 0))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001658 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001659 emsg(_(e_need_at_least_one_of_id_or_type));
Ben Jacksona7704222022-08-20 20:54:51 +01001660 goto cleanup_prop_remove;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001661 }
Ben Jacksona7704222022-08-20 20:54:51 +01001662 if (both && (id == -MAXCOL || (type_id == -1 && num_type_ids == 0)))
Bram Moolenaar49b79bd2020-03-05 21:52:55 +01001663 {
Ben Jacksona7704222022-08-20 20:54:51 +01001664 emsg(_(e_need_id_and_type_or_types_with_both));
1665 goto cleanup_prop_remove;
1666 }
1667 if (type_id != -1 && num_type_ids > 0)
1668 {
1669 emsg(_(e_cannot_specify_both_type_and_types));
1670 goto cleanup_prop_remove;
Bram Moolenaar49b79bd2020-03-05 21:52:55 +01001671 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001672
1673 if (end == 0)
1674 end = buf->b_ml.ml_line_count;
1675 for (lnum = start; lnum <= end; ++lnum)
1676 {
1677 char_u *text;
1678 size_t len;
1679
1680 if (lnum > buf->b_ml.ml_line_count)
1681 break;
1682 text = ml_get_buf(buf, lnum, FALSE);
1683 len = STRLEN(text) + 1;
1684 if ((size_t)buf->b_ml.ml_line_len > len)
1685 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001686 static textprop_T textprop; // static because of alignment
1687 unsigned idx;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001688
1689 for (idx = 0; idx < (buf->b_ml.ml_line_len - len)
1690 / sizeof(textprop_T); ++idx)
1691 {
1692 char_u *cur_prop = buf->b_ml.ml_line_ptr + len
1693 + idx * sizeof(textprop_T);
1694 size_t taillen;
Ben Jacksona7704222022-08-20 20:54:51 +01001695 int matches_id = 0;
1696 int matches_type = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001697
1698 mch_memmove(&textprop, cur_prop, sizeof(textprop_T));
Ben Jacksona7704222022-08-20 20:54:51 +01001699
1700 matches_id = textprop.tp_id == id;
1701 if (num_type_ids > 0)
1702 {
1703 int idx2;
1704
1705 for (idx2 = 0; !matches_type && idx2 < num_type_ids; ++idx2)
1706 matches_type = textprop.tp_type == type_ids[idx2];
1707 }
1708 else
1709 {
1710 matches_type = textprop.tp_type == type_id;
1711 }
1712
1713 if (both ? matches_id && matches_type
1714 : matches_id || matches_type)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001715 {
1716 if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY))
1717 {
1718 char_u *newptr = alloc(buf->b_ml.ml_line_len);
1719
1720 // need to allocate the line to be able to change it
1721 if (newptr == NULL)
Ben Jacksona7704222022-08-20 20:54:51 +01001722 goto cleanup_prop_remove;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001723 mch_memmove(newptr, buf->b_ml.ml_line_ptr,
1724 buf->b_ml.ml_line_len);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01001725 if (buf->b_ml.ml_flags & ML_ALLOCATED)
1726 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001727 buf->b_ml.ml_line_ptr = newptr;
Bram Moolenaar0a2f5782019-03-22 13:20:43 +01001728 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
1729
1730 cur_prop = buf->b_ml.ml_line_ptr + len
Bram Moolenaarf0884c52019-05-24 21:22:29 +02001731 + idx * sizeof(textprop_T);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001732 }
1733
1734 taillen = buf->b_ml.ml_line_len - len
1735 - (idx + 1) * sizeof(textprop_T);
1736 if (taillen > 0)
1737 mch_memmove(cur_prop, cur_prop + sizeof(textprop_T),
1738 taillen);
1739 buf->b_ml.ml_line_len -= sizeof(textprop_T);
1740 --idx;
1741
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001742 if (textprop.tp_id < 0)
1743 {
1744 garray_T *gap = &buf->b_textprop_text;
1745 int ii = -textprop.tp_id - 1;
1746
1747 // negative ID: property with text - free the text
1748 if (ii < gap->ga_len)
1749 {
1750 char_u **p = ((char_u **)gap->ga_data) + ii;
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00001751 VIM_CLEAR(*p);
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001752 did_remove_text = TRUE;
1753 }
1754 }
1755
Bram Moolenaar965c0442021-05-17 00:22:06 +02001756 if (first_changed == 0)
1757 first_changed = lnum;
1758 last_changed = lnum;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001759 ++rettv->vval.v_number;
1760 if (!do_all)
1761 break;
1762 }
1763 }
1764 }
1765 }
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001766
Bram Moolenaar965c0442021-05-17 00:22:06 +02001767 if (first_changed > 0)
Bram Moolenaarfc643e62021-05-17 00:15:18 +02001768 {
Bram Moolenaar326c5d32022-08-12 13:05:49 +01001769 changed_line_display_buf(buf);
Bram Moolenaar965c0442021-05-17 00:22:06 +02001770 changed_lines_buf(buf, first_changed, last_changed + 1, 0);
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001771 redraw_buf_later(buf, UPD_VALID);
Bram Moolenaarfc643e62021-05-17 00:15:18 +02001772 }
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001773
1774 if (did_remove_text)
1775 {
1776 garray_T *gap = &buf->b_textprop_text;
1777
1778 // Reduce the growarray size for NULL pointers at the end.
1779 while (gap->ga_len > 0
1780 && ((char_u **)gap->ga_data)[gap->ga_len - 1] == NULL)
1781 --gap->ga_len;
1782 }
Ben Jacksona7704222022-08-20 20:54:51 +01001783
1784cleanup_prop_remove:
1785 vim_free(type_ids);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001786}
1787
1788/*
1789 * Common for f_prop_type_add() and f_prop_type_change().
1790 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001791 static void
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001792prop_type_set(typval_T *argvars, int add)
1793{
1794 char_u *name;
1795 buf_T *buf = NULL;
1796 dict_T *dict;
1797 dictitem_T *di;
1798 proptype_T *prop;
1799
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001800 if (in_vim9script()
1801 && (check_for_string_arg(argvars, 0) == FAIL
1802 || check_for_dict_arg(argvars, 1) == FAIL))
1803 return;
1804
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001805 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001806 if (*name == NUL)
1807 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00001808 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001809 return;
1810 }
1811
1812 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1813 return;
1814 dict = argvars[1].vval.v_dict;
1815
Bram Moolenaare44336b2022-08-07 18:20:08 +01001816 prop = find_prop_type(name, buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001817 if (add)
1818 {
1819 hashtab_T **htp;
1820
1821 if (prop != NULL)
1822 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001823 semsg(_(e_property_type_str_already_defined), name);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001824 return;
1825 }
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001826 prop = alloc_clear(offsetof(proptype_T, pt_name) + STRLEN(name) + 1);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001827 if (prop == NULL)
1828 return;
1829 STRCPY(prop->pt_name, name);
1830 prop->pt_id = ++proptype_id;
Bram Moolenaar0743ef92019-11-13 16:37:31 +01001831 prop->pt_flags = PT_FLAG_COMBINE;
Bram Moolenaare44336b2022-08-07 18:20:08 +01001832 if (buf == NULL)
1833 {
1834 htp = &global_proptypes;
1835 VIM_CLEAR(global_proparray);
1836 }
1837 else
1838 {
1839 htp = &buf->b_proptypes;
1840 VIM_CLEAR(buf->b_proparray);
1841 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001842 if (*htp == NULL)
1843 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001844 *htp = ALLOC_ONE(hashtab_T);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001845 if (*htp == NULL)
Bram Moolenaarfb95e212018-12-14 12:18:11 +01001846 {
1847 vim_free(prop);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001848 return;
Bram Moolenaarfb95e212018-12-14 12:18:11 +01001849 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001850 hash_init(*htp);
1851 }
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001852 hash_add(*htp, PT2HIKEY(prop), "prop type");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001853 }
1854 else
1855 {
1856 if (prop == NULL)
1857 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001858 semsg(_(e_property_type_str_does_not_exist), name);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001859 return;
1860 }
1861 }
1862
1863 if (dict != NULL)
1864 {
1865 di = dict_find(dict, (char_u *)"highlight", -1);
1866 if (di != NULL)
1867 {
1868 char_u *highlight;
1869 int hl_id = 0;
1870
Bram Moolenaard61efa52022-07-23 09:52:04 +01001871 highlight = dict_get_string(dict, "highlight", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001872 if (highlight != NULL && *highlight != NUL)
1873 hl_id = syn_name2id(highlight);
1874 if (hl_id <= 0)
1875 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001876 semsg(_(e_unknown_highlight_group_name_str),
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001877 highlight == NULL ? (char_u *)"" : highlight);
1878 return;
1879 }
1880 prop->pt_hl_id = hl_id;
1881 }
1882
Bram Moolenaar58187f12019-05-05 16:33:47 +02001883 di = dict_find(dict, (char_u *)"combine", -1);
1884 if (di != NULL)
1885 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001886 if (tv_get_bool(&di->di_tv))
Bram Moolenaar58187f12019-05-05 16:33:47 +02001887 prop->pt_flags |= PT_FLAG_COMBINE;
1888 else
1889 prop->pt_flags &= ~PT_FLAG_COMBINE;
1890 }
1891
Bram Moolenaarf4ba8bc2022-08-05 17:05:04 +01001892 di = dict_find(dict, (char_u *)"override", -1);
1893 if (di != NULL)
1894 {
1895 if (tv_get_bool(&di->di_tv))
1896 prop->pt_flags |= PT_FLAG_OVERRIDE;
1897 else
1898 prop->pt_flags &= ~PT_FLAG_OVERRIDE;
1899 }
1900
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001901 di = dict_find(dict, (char_u *)"priority", -1);
1902 if (di != NULL)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001903 prop->pt_priority = tv_get_number(&di->di_tv);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001904
1905 di = dict_find(dict, (char_u *)"start_incl", -1);
1906 if (di != NULL)
1907 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001908 if (tv_get_bool(&di->di_tv))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001909 prop->pt_flags |= PT_FLAG_INS_START_INCL;
1910 else
1911 prop->pt_flags &= ~PT_FLAG_INS_START_INCL;
1912 }
1913
1914 di = dict_find(dict, (char_u *)"end_incl", -1);
1915 if (di != NULL)
1916 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001917 if (tv_get_bool(&di->di_tv))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001918 prop->pt_flags |= PT_FLAG_INS_END_INCL;
1919 else
1920 prop->pt_flags &= ~PT_FLAG_INS_END_INCL;
1921 }
1922 }
1923}
1924
1925/*
1926 * prop_type_add({name}, {props})
1927 */
1928 void
1929f_prop_type_add(typval_T *argvars, typval_T *rettv UNUSED)
1930{
1931 prop_type_set(argvars, TRUE);
1932}
1933
1934/*
1935 * prop_type_change({name}, {props})
1936 */
1937 void
1938f_prop_type_change(typval_T *argvars, typval_T *rettv UNUSED)
1939{
1940 prop_type_set(argvars, FALSE);
1941}
1942
1943/*
1944 * prop_type_delete({name} [, {bufnr}])
1945 */
1946 void
1947f_prop_type_delete(typval_T *argvars, typval_T *rettv UNUSED)
1948{
1949 char_u *name;
1950 buf_T *buf = NULL;
1951 hashitem_T *hi;
1952
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001953 if (in_vim9script()
1954 && (check_for_string_arg(argvars, 0) == FAIL
1955 || check_for_opt_dict_arg(argvars, 1) == FAIL))
1956 return;
1957
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001958 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001959 if (*name == NUL)
1960 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00001961 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001962 return;
1963 }
1964
1965 if (argvars[1].v_type != VAR_UNKNOWN)
1966 {
1967 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1968 return;
1969 }
1970
Bram Moolenaare44336b2022-08-07 18:20:08 +01001971 hi = find_prop_type_hi(name, buf);
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001972 if (hi == NULL)
1973 return;
1974
1975 hashtab_T *ht;
1976 proptype_T *prop = HI2PT(hi);
1977
1978 if (buf == NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001979 {
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001980 ht = global_proptypes;
1981 VIM_CLEAR(global_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001982 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001983 else
1984 {
1985 ht = buf->b_proptypes;
1986 VIM_CLEAR(buf->b_proparray);
1987 }
1988 hash_remove(ht, hi, "prop type delete");
1989 vim_free(prop);
1990
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001991 // currently visible text properties will disappear
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001992 redraw_all_later(UPD_CLEAR);
1993 changed_window_setting_buf(buf == NULL ? curbuf : buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001994}
1995
1996/*
Martin Tournoije2390c72021-07-28 13:30:16 +02001997 * prop_type_get({name} [, {props}])
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001998 */
1999 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01002000f_prop_type_get(typval_T *argvars, typval_T *rettv)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002001{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002002 char_u *name;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002003
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002004 if (in_vim9script()
2005 && (check_for_string_arg(argvars, 0) == FAIL
2006 || check_for_opt_dict_arg(argvars, 1) == FAIL))
2007 return;
2008
2009 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002010 if (*name == NUL)
2011 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00002012 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002013 return;
2014 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002015
2016 if (rettv_dict_alloc(rettv) == FAIL)
2017 return;
2018
2019 proptype_T *prop = NULL;
2020 buf_T *buf = NULL;
2021
2022 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002023 {
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002024 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
2025 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002026 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002027
2028 prop = find_prop_type(name, buf);
2029 if (prop == NULL)
2030 return;
2031
2032 dict_T *d = rettv->vval.v_dict;
2033
2034 if (prop->pt_hl_id > 0)
2035 dict_add_string(d, "highlight", syn_id2name(prop->pt_hl_id));
2036 dict_add_number(d, "priority", prop->pt_priority);
2037 dict_add_number(d, "combine",
2038 (prop->pt_flags & PT_FLAG_COMBINE) ? 1 : 0);
2039 dict_add_number(d, "start_incl",
2040 (prop->pt_flags & PT_FLAG_INS_START_INCL) ? 1 : 0);
2041 dict_add_number(d, "end_incl",
2042 (prop->pt_flags & PT_FLAG_INS_END_INCL) ? 1 : 0);
2043 if (buf != NULL)
2044 dict_add_number(d, "bufnr", buf->b_fnum);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002045}
2046
2047 static void
2048list_types(hashtab_T *ht, list_T *l)
2049{
2050 long todo;
2051 hashitem_T *hi;
2052
2053 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002054 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002055 {
2056 if (!HASHITEM_EMPTY(hi))
2057 {
2058 proptype_T *prop = HI2PT(hi);
2059
2060 list_append_string(l, prop->pt_name, -1);
2061 --todo;
2062 }
2063 }
2064}
2065
2066/*
2067 * prop_type_list([{bufnr}])
2068 */
2069 void
2070f_prop_type_list(typval_T *argvars, typval_T *rettv UNUSED)
2071{
2072 buf_T *buf = NULL;
2073
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002074 if (rettv_list_alloc(rettv) == FAIL)
2075 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002076
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002077 if (in_vim9script() && check_for_opt_dict_arg(argvars, 0) == FAIL)
2078 return;
2079
2080 if (argvars[0].v_type != VAR_UNKNOWN)
2081 {
2082 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
2083 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002084 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002085 if (buf == NULL)
2086 {
2087 if (global_proptypes != NULL)
2088 list_types(global_proptypes, rettv->vval.v_list);
2089 }
2090 else if (buf->b_proptypes != NULL)
2091 list_types(buf->b_proptypes, rettv->vval.v_list);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002092}
2093
2094/*
2095 * Free all property types in "ht".
2096 */
2097 static void
2098clear_ht_prop_types(hashtab_T *ht)
2099{
2100 long todo;
2101 hashitem_T *hi;
2102
2103 if (ht == NULL)
2104 return;
2105
2106 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002107 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002108 {
2109 if (!HASHITEM_EMPTY(hi))
2110 {
2111 proptype_T *prop = HI2PT(hi);
2112
2113 vim_free(prop);
2114 --todo;
2115 }
2116 }
2117
2118 hash_clear(ht);
2119 vim_free(ht);
2120}
2121
2122#if defined(EXITFREE) || defined(PROTO)
2123/*
Bram Moolenaarfb95e212018-12-14 12:18:11 +01002124 * Free all global property types.
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002125 */
2126 void
2127clear_global_prop_types(void)
2128{
2129 clear_ht_prop_types(global_proptypes);
2130 global_proptypes = NULL;
Bram Moolenaare44336b2022-08-07 18:20:08 +01002131 VIM_CLEAR(global_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002132}
2133#endif
2134
2135/*
2136 * Free all property types for "buf".
2137 */
2138 void
2139clear_buf_prop_types(buf_T *buf)
2140{
2141 clear_ht_prop_types(buf->b_proptypes);
2142 buf->b_proptypes = NULL;
Bram Moolenaare44336b2022-08-07 18:20:08 +01002143 VIM_CLEAR(buf->b_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002144}
2145
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002146// Struct used to return two values from adjust_prop().
2147typedef struct
2148{
2149 int dirty; // if the property was changed
2150 int can_drop; // whether after this change, the prop may be removed
2151} adjustres_T;
2152
2153/*
2154 * Adjust the property for "added" bytes (can be negative) inserted at "col".
2155 *
2156 * Note that "col" is zero-based, while tp_col is one-based.
2157 * Only for the current buffer.
2158 * "flags" can have:
2159 * APC_SUBSTITUTE: Text is replaced, not inserted.
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002160 * APC_INDENT: Text is inserted before virtual text prop
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002161 */
2162 static adjustres_T
2163adjust_prop(
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002164 textprop_T *prop,
2165 colnr_T col,
2166 int added,
2167 int flags)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002168{
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002169 proptype_T *pt;
2170 int start_incl;
2171 int end_incl;
2172 int droppable;
2173 adjustres_T res = {TRUE, FALSE};
2174
2175 // prop after end of the line doesn't move
2176 if (prop->tp_col == MAXCOL)
2177 {
2178 res.dirty = FALSE;
2179 return res;
2180 }
2181
2182 pt = text_prop_type_by_id(curbuf, prop->tp_type);
2183 start_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_START_INCL))
LemonBoy698cb4c2022-05-14 18:10:15 +01002184 || (flags & APC_SUBSTITUTE)
2185 || (prop->tp_flags & TP_FLAG_CONT_PREV);
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002186 if (prop->tp_id < 0 && (flags & APC_INDENT))
2187 // when inserting indent just before a character with virtual text
2188 // shift the text property
2189 start_incl = FALSE;
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002190 end_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_END_INCL))
LemonBoy698cb4c2022-05-14 18:10:15 +01002191 || (prop->tp_flags & TP_FLAG_CONT_NEXT);
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002192 // do not drop zero-width props if they later can increase in size
2193 droppable = !(start_incl || end_incl);
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002194
2195 if (added > 0)
2196 {
2197 if (col + 1 <= prop->tp_col
2198 - (start_incl || (prop->tp_len == 0 && end_incl)))
2199 // Change is entirely before the text property: Only shift
2200 prop->tp_col += added;
2201 else if (col + 1 < prop->tp_col + prop->tp_len + end_incl)
2202 // Insertion was inside text property
2203 prop->tp_len += added;
2204 }
2205 else if (prop->tp_col > col + 1)
2206 {
2207 if (prop->tp_col + added < col + 1)
2208 {
2209 prop->tp_len += (prop->tp_col - 1 - col) + added;
2210 prop->tp_col = col + 1;
2211 if (prop->tp_len <= 0)
2212 {
2213 prop->tp_len = 0;
2214 res.can_drop = droppable;
2215 }
2216 }
2217 else
2218 prop->tp_col += added;
2219 }
Bram Moolenaarf5240b92022-08-24 12:24:37 +01002220 else if (prop->tp_len > 0 && prop->tp_col + prop->tp_len > col
2221 && prop->tp_id >= 0) // don't change length for virtual text
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002222 {
2223 int after = col - added - (prop->tp_col - 1 + prop->tp_len);
2224
2225 prop->tp_len += after > 0 ? added + after : added;
2226 res.can_drop = prop->tp_len <= 0 && droppable;
2227 }
2228 else
2229 res.dirty = FALSE;
2230
2231 return res;
2232}
2233
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002234/*
2235 * Adjust the columns of text properties in line "lnum" after position "col" to
2236 * shift by "bytes_added" (can be negative).
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002237 * Note that "col" is zero-based, while tp_col is one-based.
2238 * Only for the current buffer.
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002239 * "flags" can have:
2240 * APC_SAVE_FOR_UNDO: Call u_savesub() before making changes to the line.
2241 * APC_SUBSTITUTE: Text is replaced, not inserted.
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002242 * APC_INDENT: Text is inserted before virtual text prop
Bram Moolenaar8055d172019-05-17 22:57:26 +02002243 * Caller is expected to check b_has_textprop and "bytes_added" being non-zero.
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002244 * Returns TRUE when props were changed.
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002245 */
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002246 int
Bram Moolenaar196d1572019-01-02 23:47:18 +01002247adjust_prop_columns(
2248 linenr_T lnum,
2249 colnr_T col,
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002250 int bytes_added,
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002251 int flags)
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002252{
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002253 int proplen;
2254 char_u *props;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002255 int dirty = FALSE;
Bram Moolenaar196d1572019-01-02 23:47:18 +01002256 int ri, wi;
2257 size_t textlen;
2258
2259 if (text_prop_frozen > 0)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002260 return FALSE;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002261
2262 proplen = get_text_props(curbuf, lnum, &props, TRUE);
2263 if (proplen == 0)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002264 return FALSE;
Bram Moolenaar196d1572019-01-02 23:47:18 +01002265 textlen = curbuf->b_ml.ml_line_len - proplen * sizeof(textprop_T);
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002266
Bram Moolenaar196d1572019-01-02 23:47:18 +01002267 wi = 0; // write index
2268 for (ri = 0; ri < proplen; ++ri)
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002269 {
Bram Moolenaar12f20032020-02-26 22:06:00 +01002270 textprop_T prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002271 adjustres_T res;
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002272
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002273 mch_memmove(&prop, props + ri * sizeof(prop), sizeof(prop));
2274 res = adjust_prop(&prop, col, bytes_added, flags);
2275 if (res.dirty)
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002276 {
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002277 // Save for undo if requested and not done yet.
Bram Moolenaarcf070112020-06-29 23:02:21 +02002278 if ((flags & APC_SAVE_FOR_UNDO) && !dirty
2279 && u_savesub(lnum) == FAIL)
2280 return FALSE;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002281 dirty = TRUE;
Bram Moolenaar8902b312020-09-20 21:04:35 +02002282
2283 // u_savesub() may have updated curbuf->b_ml, fetch it again
2284 if (curbuf->b_ml.ml_line_lnum != lnum)
2285 proplen = get_text_props(curbuf, lnum, &props, TRUE);
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002286 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002287 if (res.can_drop)
2288 continue; // Drop this text property
Bram Moolenaar12f20032020-02-26 22:06:00 +01002289 mch_memmove(props + wi * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaar196d1572019-01-02 23:47:18 +01002290 ++wi;
2291 }
2292 if (dirty)
2293 {
Bram Moolenaar4614f532019-01-06 12:54:55 +01002294 colnr_T newlen = (int)textlen + wi * (colnr_T)sizeof(textprop_T);
2295
2296 if ((curbuf->b_ml.ml_flags & ML_LINE_DIRTY) == 0)
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002297 {
2298 char_u *p = vim_memsave(curbuf->b_ml.ml_line_ptr, newlen);
2299
2300 if (curbuf->b_ml.ml_flags & ML_ALLOCATED)
2301 vim_free(curbuf->b_ml.ml_line_ptr);
2302 curbuf->b_ml.ml_line_ptr = p;
2303 }
Bram Moolenaar196d1572019-01-02 23:47:18 +01002304 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
Bram Moolenaar4614f532019-01-06 12:54:55 +01002305 curbuf->b_ml.ml_line_len = newlen;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002306 }
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002307 return dirty;
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002308}
2309
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002310/*
2311 * Adjust text properties for a line that was split in two.
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002312 * "lnum_props" is the line that has the properties from before the split.
2313 * "lnum_top" is the top line.
2314 * "kept" is the number of bytes kept in the first line, while
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002315 * "deleted" is the number of bytes deleted.
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002316 * "at_eol" is true if the split is after the end of the line.
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002317 */
2318 void
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002319adjust_props_for_split(
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002320 linenr_T lnum_props,
2321 linenr_T lnum_top,
2322 int kept,
2323 int deleted,
2324 int at_eol)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002325{
2326 char_u *props;
2327 int count;
2328 garray_T prevprop;
2329 garray_T nextprop;
2330 int i;
2331 int skipped = kept + deleted;
2332
2333 if (!curbuf->b_has_textprop)
2334 return;
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002335
2336 // Get the text properties from "lnum_props".
2337 count = get_text_props(curbuf, lnum_props, &props, FALSE);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002338 ga_init2(&prevprop, sizeof(textprop_T), 10);
2339 ga_init2(&nextprop, sizeof(textprop_T), 10);
2340
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002341 // Keep the relevant ones in the first line, reducing the length if needed.
2342 // Copy the ones that include the split to the second line.
2343 // Move the ones after the split to the second line.
2344 for (i = 0; i < count; ++i)
2345 {
2346 textprop_T prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002347 proptype_T *pt;
2348 int start_incl, end_incl;
2349 int cont_prev, cont_next;
Bram Moolenaar3b93cf22022-09-13 18:34:18 +01002350 int prop_col;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002351
2352 // copy the prop to an aligned structure
2353 mch_memmove(&prop, props + i * sizeof(textprop_T), sizeof(textprop_T));
2354
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002355 pt = text_prop_type_by_id(curbuf, prop.tp_type);
2356 start_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_START_INCL));
2357 end_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_END_INCL));
Bram Moolenaar3b93cf22022-09-13 18:34:18 +01002358
2359 // a text prop "above" behaves like it is on the first text column
2360 prop_col = (prop.tp_flags & TP_FLAG_ALIGN_ABOVE) ? 1 : prop.tp_col;
2361
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002362 if (prop_col == MAXCOL)
2363 {
2364 cont_prev = at_eol;
2365 cont_next = !at_eol;
2366 }
2367 else
2368 {
2369 cont_prev = prop_col + !start_incl <= kept;
2370 cont_next = skipped <= prop_col + prop.tp_len - !end_incl;
2371 }
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002372 // when a prop has text it is never copied
2373 if (prop.tp_id < 0 && cont_next)
2374 cont_prev = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002375
2376 if (cont_prev && ga_grow(&prevprop, 1) == OK)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002377 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002378 textprop_T *p = ((textprop_T *)prevprop.ga_data) + prevprop.ga_len;
2379
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002380 *p = prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002381 ++prevprop.ga_len;
Bram Moolenaar98b37302022-09-14 12:06:53 +01002382 if (p->tp_col != MAXCOL && p->tp_col + p->tp_len >= kept)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002383 p->tp_len = kept - p->tp_col;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002384 if (cont_next)
2385 p->tp_flags |= TP_FLAG_CONT_NEXT;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002386 }
2387
Bram Moolenaar5c65e6a2019-05-17 11:08:56 +02002388 // Only add the property to the next line if the length is bigger than
2389 // zero.
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002390 if (cont_next && ga_grow(&nextprop, 1) == OK)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002391 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002392 textprop_T *p = ((textprop_T *)nextprop.ga_data) + nextprop.ga_len;
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002393
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002394 *p = prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002395 ++nextprop.ga_len;
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002396 if (p->tp_col != MAXCOL)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002397 {
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002398 if (p->tp_col > skipped)
2399 p->tp_col -= skipped - 1;
2400 else
2401 {
2402 p->tp_len -= skipped - p->tp_col;
2403 p->tp_col = 1;
2404 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002405 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002406 if (cont_prev)
2407 p->tp_flags |= TP_FLAG_CONT_PREV;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002408 }
2409 }
2410
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002411 set_text_props(lnum_top, prevprop.ga_data,
2412 prevprop.ga_len * sizeof(textprop_T));
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002413 ga_clear(&prevprop);
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002414 set_text_props(lnum_top + 1, nextprop.ga_data,
2415 nextprop.ga_len * sizeof(textprop_T));
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002416 ga_clear(&nextprop);
2417}
2418
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002419/*
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002420 * Prepend properties of joined line "lnum" to "new_props".
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002421 */
2422 void
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002423prepend_joined_props(
2424 char_u *new_props,
2425 int propcount,
2426 int *props_remaining,
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002427 linenr_T lnum,
Bram Moolenaare175dc62022-08-01 22:18:50 +01002428 int last_line,
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002429 long col,
2430 int removed)
2431{
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002432 char_u *props;
2433 int proplen = get_text_props(curbuf, lnum, &props, FALSE);
2434 int i;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002435
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002436 for (i = proplen; i-- > 0; )
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002437 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002438 textprop_T prop;
2439 int end;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002440
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002441 mch_memmove(&prop, props + i * sizeof(prop), sizeof(prop));
Bram Moolenaare175dc62022-08-01 22:18:50 +01002442 if (prop.tp_col == MAXCOL && !last_line)
2443 continue; // drop property with text after the line
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002444 end = !(prop.tp_flags & TP_FLAG_CONT_NEXT);
2445
2446 adjust_prop(&prop, 0, -removed, 0); // Remove leading spaces
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002447 adjust_prop(&prop, -1, col, 0); // Make line start at its final column
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002448
Bram Moolenaare175dc62022-08-01 22:18:50 +01002449 if (last_line || end)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002450 mch_memmove(new_props + --(*props_remaining) * sizeof(prop),
2451 &prop, sizeof(prop));
2452 else
2453 {
2454 int j;
2455 int found = FALSE;
2456
2457 // Search for continuing prop.
2458 for (j = *props_remaining; j < propcount; ++j)
2459 {
2460 textprop_T op;
2461
2462 mch_memmove(&op, new_props + j * sizeof(op), sizeof(op));
2463 if ((op.tp_flags & TP_FLAG_CONT_PREV)
2464 && op.tp_id == prop.tp_id && op.tp_type == prop.tp_type)
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002465 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002466 found = TRUE;
2467 op.tp_len += op.tp_col - prop.tp_col;
2468 op.tp_col = prop.tp_col;
2469 // Start/end is taken care of when deleting joined lines
2470 op.tp_flags = prop.tp_flags;
2471 mch_memmove(new_props + j * sizeof(op), &op, sizeof(op));
2472 break;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002473 }
2474 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002475 if (!found)
2476 internal_error("text property above joined line not found");
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002477 }
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002478 }
2479}
2480
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002481#endif // FEAT_PROP_POPUP