blob: a9765701895cbed5924ea5aaa8d6f6568263aa08 [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);
zeertzjq94b7c322024-03-12 21:50:32 +0100640 textlen = ml_get_buf_len(buf, lnum) + 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100641 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;
Dylan Thacker-Smith80557212024-02-21 21:00:59 +0100761
762 // property that inserts text has priority over one that doesn't
763 if ((tp1->tp_id < 0) != (tp2->tp_id < 0))
764 return tp1->tp_id < 0 ? 1 : -1;
765
zeertzjqce53e3e2023-09-01 18:49:30 +0200766 if (col1 == MAXCOL || col2 == MAXCOL)
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100767 {
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100768 int order1 = text_prop_order(tp1->tp_flags);
769 int order2 = text_prop_order(tp2->tp_flags);
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100770
zeertzjqce53e3e2023-09-01 18:49:30 +0200771 // sort on order where it is added
Bram Moolenaar04e0ed12022-09-10 20:00:56 +0100772 if (order1 != order2)
773 return order1 < order2 ? 1 : -1;
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100774 }
775
Bram Moolenaarf396ce82022-08-23 18:39:37 +0100776 // check highest priority, defined by the type
777 pt1 = text_prop_type_by_id(text_prop_compare_buf, tp1->tp_type);
778 pt2 = text_prop_type_by_id(text_prop_compare_buf, tp2->tp_type);
779 if (pt1 != pt2)
780 {
781 if (pt1 == NULL)
782 return -1;
783 if (pt2 == NULL)
784 return 1;
785 if (pt1->pt_priority != pt2->pt_priority)
786 return pt1->pt_priority > pt2->pt_priority ? 1 : -1;
787 }
788
789 // same priority, one that starts first wins
790 if (col1 != col2)
791 return col1 < col2 ? 1 : -1;
792
793 // for a property with text the id can be used as tie breaker
794 if (tp1->tp_id < 0)
795 return tp1->tp_id > tp2->tp_id ? 1 : -1;
796
797 return 0;
798}
799
800/*
801 * Sort "count" text properties using an array if indexes "idxs" into the list
802 * of text props "props" for buffer "buf".
803 */
804 void
805sort_text_props(
806 buf_T *buf,
807 textprop_T *props,
808 int *idxs,
809 int count)
810{
811 text_prop_compare_buf = buf;
812 text_prop_compare_props = props;
813 qsort((void *)idxs, (size_t)count, sizeof(int), text_prop_compare);
814}
815
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100816/*
Bram Moolenaar12034e22019-08-25 22:25:02 +0200817 * Find text property "type_id" in the visible lines of window "wp".
818 * Match "id" when it is > 0.
819 * Returns FAIL when not found.
820 */
821 int
Bram Moolenaar89469d12022-12-02 20:46:26 +0000822find_visible_prop(
823 win_T *wp,
824 int type_id,
825 int id,
826 textprop_T *prop,
827 linenr_T *found_lnum)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200828{
Bram Moolenaar89469d12022-12-02 20:46:26 +0000829 // return when "type_id" no longer exists
830 if (text_prop_type_by_id(wp->w_buffer, type_id) == NULL)
831 return FAIL;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200832
833 // w_botline may not have been updated yet.
Bram Moolenaar23999d72020-12-23 14:36:00 +0100834 validate_botline_win(wp);
Bram Moolenaar89469d12022-12-02 20:46:26 +0000835 for (linenr_T lnum = wp->w_topline; lnum < wp->w_botline; ++lnum)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200836 {
Bram Moolenaar89469d12022-12-02 20:46:26 +0000837 char_u *props;
838 int count = get_text_props(wp->w_buffer, lnum, &props, FALSE);
839 for (int i = 0; i < count; ++i)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200840 {
841 mch_memmove(prop, props + i * sizeof(textprop_T),
842 sizeof(textprop_T));
843 if (prop->tp_type == type_id && (id <= 0 || prop->tp_id == id))
844 {
845 *found_lnum = lnum;
846 return OK;
847 }
848 }
849 }
850 return FAIL;
851}
852
853/*
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100854 * Set the text properties for line "lnum" to "props" with length "len".
855 * If "len" is zero text properties are removed, "props" is not used.
856 * Any existing text properties are dropped.
857 * Only works for the current buffer.
858 */
859 static void
860set_text_props(linenr_T lnum, char_u *props, int len)
861{
Bram Moolenaar8aef43b2019-01-08 20:14:35 +0100862 char_u *text;
863 char_u *newtext;
864 int textlen;
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100865
866 text = ml_get(lnum);
zeertzjq94b7c322024-03-12 21:50:32 +0100867 textlen = ml_get_len(lnum) + 1;
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100868 newtext = alloc(textlen + len);
869 if (newtext == NULL)
870 return;
871 mch_memmove(newtext, text, textlen);
872 if (len > 0)
873 mch_memmove(newtext + textlen, props, len);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +0100874 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
Bram Moolenaar4164bb22019-01-04 23:09:49 +0100875 vim_free(curbuf->b_ml.ml_line_ptr);
876 curbuf->b_ml.ml_line_ptr = newtext;
877 curbuf->b_ml.ml_line_len = textlen + len;
878 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
879}
880
Bram Moolenaar213bbaf2022-08-05 19:46:48 +0100881/*
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +0100882 * Add "text_props" with "text_prop_count" text properties to line "lnum".
Bram Moolenaar213bbaf2022-08-05 19:46:48 +0100883 */
884 void
885add_text_props(linenr_T lnum, textprop_T *text_props, int text_prop_count)
886{
887 char_u *text;
888 char_u *newtext;
889 int proplen = text_prop_count * (int)sizeof(textprop_T);
890
891 text = ml_get(lnum);
892 newtext = alloc(curbuf->b_ml.ml_line_len + proplen);
893 if (newtext == NULL)
894 return;
895 mch_memmove(newtext, text, curbuf->b_ml.ml_line_len);
896 mch_memmove(newtext + curbuf->b_ml.ml_line_len, text_props, proplen);
897 if (curbuf->b_ml.ml_flags & (ML_LINE_DIRTY | ML_ALLOCATED))
898 vim_free(curbuf->b_ml.ml_line_ptr);
899 curbuf->b_ml.ml_line_ptr = newtext;
900 curbuf->b_ml.ml_line_len += proplen;
901 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
902}
903
Bram Moolenaare44336b2022-08-07 18:20:08 +0100904/*
905 * Function passed to qsort() for sorting proptype_T on pt_id.
906 */
907 static int
908compare_pt(const void *s1, const void *s2)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100909{
Bram Moolenaare44336b2022-08-07 18:20:08 +0100910 proptype_T *tp1 = *(proptype_T **)s1;
911 proptype_T *tp2 = *(proptype_T **)s2;
912
913 return tp1->pt_id == tp2->pt_id ? 0 : tp1->pt_id < tp2->pt_id ? -1 : 1;
914}
915
916 static proptype_T *
917find_type_by_id(hashtab_T *ht, proptype_T ***array, int id)
918{
919 int low = 0;
920 int high;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100921
Bram Moolenaar10246902022-08-08 17:08:05 +0100922 if (ht == NULL || ht->ht_used == 0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100923 return NULL;
924
dundargocc57b5bc2022-11-02 13:30:51 +0000925 // Make the lookup faster by creating an array with pointers to
Bram Moolenaare44336b2022-08-07 18:20:08 +0100926 // hashtable entries, sorted on pt_id.
927 if (*array == NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100928 {
Bram Moolenaare44336b2022-08-07 18:20:08 +0100929 long todo;
930 hashitem_T *hi;
931 int i = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100932
Bram Moolenaare44336b2022-08-07 18:20:08 +0100933 *array = ALLOC_MULT(proptype_T *, ht->ht_used);
934 if (*array == NULL)
935 return NULL;
936 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +0000937 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaare44336b2022-08-07 18:20:08 +0100938 {
939 if (!HASHITEM_EMPTY(hi))
940 {
941 (*array)[i++] = HI2PT(hi);
942 --todo;
943 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100944 }
Bram Moolenaare44336b2022-08-07 18:20:08 +0100945 qsort((void *)*array, ht->ht_used, sizeof(proptype_T *), compare_pt);
946 }
947
948 // binary search in the sorted array
949 high = ht->ht_used;
950 while (high > low)
951 {
952 int m = (high + low) / 2;
953
954 if ((*array)[m]->pt_id == id)
955 return (*array)[m];
956 if ((*array)[m]->pt_id > id)
957 high = m;
958 else
959 low = m + 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100960 }
961 return NULL;
962}
963
964/*
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100965 * Fill 'dict' with text properties in 'prop'.
966 */
967 static void
968prop_fill_dict(dict_T *dict, textprop_T *prop, buf_T *buf)
969{
970 proptype_T *pt;
Martin Tournoije2390c72021-07-28 13:30:16 +0200971 int buflocal = TRUE;
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200972 int virtualtext_prop = prop->tp_id < 0;
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100973
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200974 dict_add_number(dict, "col", (prop->tp_col == MAXCOL) ? 0 : prop->tp_col);
975 if (!virtualtext_prop)
976 {
977 dict_add_number(dict, "length", prop->tp_len);
978 dict_add_number(dict, "id", prop->tp_id);
979 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100980 dict_add_number(dict, "start", !(prop->tp_flags & TP_FLAG_CONT_PREV));
981 dict_add_number(dict, "end", !(prop->tp_flags & TP_FLAG_CONT_NEXT));
Martin Tournoije2390c72021-07-28 13:30:16 +0200982
Bram Moolenaare44336b2022-08-07 18:20:08 +0100983 pt = find_type_by_id(buf->b_proptypes, &buf->b_proparray, prop->tp_type);
Martin Tournoije2390c72021-07-28 13:30:16 +0200984 if (pt == NULL)
985 {
Bram Moolenaare44336b2022-08-07 18:20:08 +0100986 pt = find_type_by_id(global_proptypes, &global_proparray,
987 prop->tp_type);
Martin Tournoije2390c72021-07-28 13:30:16 +0200988 buflocal = FALSE;
989 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +0100990 if (pt != NULL)
991 dict_add_string(dict, "type", pt->pt_name);
Martin Tournoije2390c72021-07-28 13:30:16 +0200992
993 if (buflocal)
994 dict_add_number(dict, "type_bufnr", buf->b_fnum);
995 else
996 dict_add_number(dict, "type_bufnr", 0);
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +0200997 if (virtualtext_prop)
Yegappan Lakshmananf9037f12023-08-20 18:27:45 +0200998 {
999 // virtual text property
1000 garray_T *gap = &buf->b_textprop_text;
1001 char_u *text;
1002
1003 // negate the property id to get the string index
1004 text = ((char_u **)gap->ga_data)[-prop->tp_id - 1];
1005 dict_add_string(dict, "text", text);
1006
1007 // text_align
1008 char_u *text_align = NULL;
1009 if (prop->tp_flags & TP_FLAG_ALIGN_RIGHT)
1010 text_align = (char_u *)"right";
1011 else if (prop->tp_flags & TP_FLAG_ALIGN_ABOVE)
1012 text_align = (char_u *)"above";
1013 else if (prop->tp_flags & TP_FLAG_ALIGN_BELOW)
1014 text_align = (char_u *)"below";
1015 if (text_align != NULL)
1016 dict_add_string(dict, "text_align", text_align);
1017
1018 // text_wrap
1019 if (prop->tp_flags & TP_FLAG_WRAP)
1020 dict_add_string(dict, "text_wrap", (char_u *)"wrap");
Yegappan Lakshmanan171c5b92023-08-22 21:48:50 +02001021 if (prop->tp_padleft != 0)
1022 dict_add_number(dict, "text_padding_left", prop->tp_padleft);
Yegappan Lakshmananf9037f12023-08-20 18:27:45 +02001023 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001024}
1025
1026/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001027 * Find a property type by ID in "buf" or globally.
1028 * Returns NULL if not found.
1029 */
1030 proptype_T *
1031text_prop_type_by_id(buf_T *buf, int id)
1032{
1033 proptype_T *type;
1034
Bram Moolenaare44336b2022-08-07 18:20:08 +01001035 type = find_type_by_id(buf->b_proptypes, &buf->b_proparray, id);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001036 if (type == NULL)
Bram Moolenaare44336b2022-08-07 18:20:08 +01001037 type = find_type_by_id(global_proptypes, &global_proparray, id);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001038 return type;
1039}
1040
1041/*
Bram Moolenaar89469d12022-12-02 20:46:26 +00001042 * Return TRUE if "prop" is a valid text property type.
1043 */
1044 int
1045text_prop_type_valid(buf_T *buf, textprop_T *prop)
1046{
1047 return text_prop_type_by_id(buf, prop->tp_type) != NULL;
1048}
1049
1050/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001051 * prop_clear({lnum} [, {lnum_end} [, {bufnr}]])
1052 */
1053 void
1054f_prop_clear(typval_T *argvars, typval_T *rettv UNUSED)
1055{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001056 linenr_T start;
1057 linenr_T end;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001058 linenr_T lnum;
1059 buf_T *buf = curbuf;
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001060 int did_clear = FALSE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001061
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001062 if (in_vim9script()
1063 && (check_for_number_arg(argvars, 0) == FAIL
1064 || check_for_opt_number_arg(argvars, 1) == FAIL
1065 || (argvars[1].v_type != VAR_UNKNOWN
1066 && check_for_opt_dict_arg(argvars, 2) == FAIL)))
1067 return;
1068
1069 start = tv_get_number(&argvars[0]);
1070 end = start;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001071 if (argvars[1].v_type != VAR_UNKNOWN)
1072 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001073 end = tv_get_number(&argvars[1]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001074 if (argvars[2].v_type != VAR_UNKNOWN)
1075 {
1076 if (get_bufnr_from_arg(&argvars[2], &buf) == FAIL)
1077 return;
1078 }
1079 }
1080 if (start < 1 || end < 1)
1081 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001082 emsg(_(e_invalid_range));
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001083 return;
1084 }
1085
1086 for (lnum = start; lnum <= end; ++lnum)
1087 {
1088 char_u *text;
1089 size_t len;
1090
1091 if (lnum > buf->b_ml.ml_line_count)
1092 break;
1093 text = ml_get_buf(buf, lnum, FALSE);
zeertzjq94b7c322024-03-12 21:50:32 +01001094 len = ml_get_buf_len(buf, lnum) + 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001095 if ((size_t)buf->b_ml.ml_line_len > len)
1096 {
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001097 did_clear = TRUE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001098 if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY))
1099 {
1100 char_u *newtext = vim_strsave(text);
1101
1102 // need to allocate the line now
1103 if (newtext == NULL)
1104 return;
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01001105 if (buf->b_ml.ml_flags & ML_ALLOCATED)
1106 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001107 buf->b_ml.ml_line_ptr = newtext;
1108 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
1109 }
Bram Moolenaar4efe73b2018-12-16 14:37:39 +01001110 buf->b_ml.ml_line_len = (int)len;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001111 }
1112 }
Bram Moolenaarda1dbed2021-03-22 19:43:34 +01001113 if (did_clear)
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001114 redraw_buf_later(buf, UPD_NOT_VALID);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001115}
1116
1117/*
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001118 * prop_find({props} [, {direction}])
1119 */
1120 void
1121f_prop_find(typval_T *argvars, typval_T *rettv)
1122{
1123 pos_T *cursor = &curwin->w_cursor;
1124 dict_T *dict;
1125 buf_T *buf = curbuf;
1126 dictitem_T *di;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001127 int lnum_start;
1128 int start_pos_has_prop = 0;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001129 int seen_end = FALSE;
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001130 int id = 0;
1131 int id_found = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001132 int type_id = -1;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001133 int skipstart = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001134 int lnum = -1;
1135 int col = -1;
LemonBoy9bd3ce22022-04-18 21:54:02 +01001136 int dir = FORWARD; // FORWARD == 1, BACKWARD == -1
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001137 int both;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001138
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001139 if (in_vim9script()
1140 && (check_for_dict_arg(argvars, 0) == FAIL
1141 || check_for_opt_string_arg(argvars, 1) == FAIL))
1142 return;
1143
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001144 if (check_for_nonnull_dict_arg(argvars, 0) == FAIL)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001145 return;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001146 dict = argvars[0].vval.v_dict;
1147
1148 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
1149 return;
1150 if (buf->b_ml.ml_mfp == NULL)
1151 return;
1152
1153 if (argvars[1].v_type != VAR_UNKNOWN)
1154 {
1155 char_u *dir_s = tv_get_string(&argvars[1]);
1156
1157 if (*dir_s == 'b')
LemonBoy9bd3ce22022-04-18 21:54:02 +01001158 dir = BACKWARD;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001159 else if (*dir_s != 'f')
1160 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001161 emsg(_(e_invalid_argument));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001162 return;
1163 }
1164 }
1165
1166 di = dict_find(dict, (char_u *)"lnum", -1);
1167 if (di != NULL)
1168 lnum = tv_get_number(&di->di_tv);
1169
1170 di = dict_find(dict, (char_u *)"col", -1);
1171 if (di != NULL)
1172 col = tv_get_number(&di->di_tv);
1173
1174 if (lnum == -1)
1175 {
1176 lnum = cursor->lnum;
1177 col = cursor->col + 1;
1178 }
1179 else if (col == -1)
1180 col = 1;
1181
1182 if (lnum < 1 || lnum > buf->b_ml.ml_line_count)
1183 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001184 emsg(_(e_invalid_range));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001185 return;
1186 }
1187
Bram Moolenaard61efa52022-07-23 09:52:04 +01001188 skipstart = dict_get_bool(dict, "skipstart", 0);
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001189
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001190 if (dict_has_key(dict, "id"))
Bram Moolenaar8e3fc132021-07-31 18:33:57 +02001191 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001192 id = dict_get_number(dict, "id");
Bram Moolenaare041dde2021-08-01 21:30:12 +02001193 id_found = TRUE;
Bram Moolenaar8e3fc132021-07-31 18:33:57 +02001194 }
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001195 if (dict_has_key(dict, "type"))
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001196 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001197 char_u *name = dict_get_string(dict, "type", FALSE);
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001198 proptype_T *type = lookup_prop_type(name, buf);
1199
1200 if (type == NULL)
1201 return;
1202 type_id = type->pt_id;
1203 }
Bram Moolenaard61efa52022-07-23 09:52:04 +01001204 both = dict_get_bool(dict, "both", FALSE);
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001205 if (!id_found && type_id == -1)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001206 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001207 emsg(_(e_need_at_least_one_of_id_or_type));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001208 return;
1209 }
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001210 if (both && (!id_found || type_id == -1))
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001211 {
Ben Jacksona7704222022-08-20 20:54:51 +01001212 emsg(_(e_need_id_and_type_or_types_with_both));
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001213 return;
1214 }
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001215
1216 lnum_start = lnum;
1217
1218 if (rettv_dict_alloc(rettv) == FAIL)
1219 return;
1220
1221 while (1)
1222 {
1223 char_u *text = ml_get_buf(buf, lnum, FALSE);
zeertzjq94b7c322024-03-12 21:50:32 +01001224 size_t textlen = ml_get_buf_len(buf, lnum) + 1;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001225 int count = (int)((buf->b_ml.ml_line_len - textlen)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001226 / sizeof(textprop_T));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001227 int i;
1228 textprop_T prop;
1229 int prop_start;
1230 int prop_end;
1231
LemonBoy9bd3ce22022-04-18 21:54:02 +01001232 for (i = dir == BACKWARD ? count - 1 : 0; i >= 0 && i < count; i += dir)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001233 {
1234 mch_memmove(&prop, text + textlen + i * sizeof(textprop_T),
LemonBoy9bd3ce22022-04-18 21:54:02 +01001235 sizeof(textprop_T));
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001236
LemonBoy9bd3ce22022-04-18 21:54:02 +01001237 // For the very first line try to find the first property before or
1238 // after `col`, depending on the search direction.
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001239 if (lnum == lnum_start)
Bram Moolenaar965fd8d2020-03-14 07:46:40 +01001240 {
LemonBoy9bd3ce22022-04-18 21:54:02 +01001241 if (dir == BACKWARD)
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001242 {
LemonBoy9bd3ce22022-04-18 21:54:02 +01001243 if (prop.tp_col > col)
1244 continue;
Bram Moolenaar346f18e2020-03-13 21:36:40 +01001245 }
1246 else if (prop.tp_col + prop.tp_len - (prop.tp_len != 0) < col)
1247 continue;
Bram Moolenaar965fd8d2020-03-14 07:46:40 +01001248 }
Bram Moolenaar24f21fd2021-03-27 22:07:29 +01001249 if (both ? prop.tp_id == id && prop.tp_type == type_id
Bram Moolenaar0d4d9ee2021-08-01 19:28:15 +02001250 : (id_found && prop.tp_id == id)
1251 || prop.tp_type == type_id)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001252 {
1253 // Check if the starting position has text props.
Bram Moolenaar66b98852020-03-11 19:15:52 +01001254 if (lnum_start == lnum
1255 && col >= prop.tp_col
1256 && (col <= prop.tp_col + prop.tp_len
1257 - (prop.tp_len != 0)))
1258 start_pos_has_prop = 1;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001259
LemonBoy9bd3ce22022-04-18 21:54:02 +01001260 // The property was not continued from last line, it starts on
1261 // this line.
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001262 prop_start = !(prop.tp_flags & TP_FLAG_CONT_PREV);
LemonBoy9bd3ce22022-04-18 21:54:02 +01001263 // The property does not continue on the next line, it ends on
1264 // this line.
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001265 prop_end = !(prop.tp_flags & TP_FLAG_CONT_NEXT);
LemonBoy9bd3ce22022-04-18 21:54:02 +01001266 if (!prop_start && prop_end && dir == FORWARD)
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001267 seen_end = 1;
1268
1269 // Skip lines without the start flag.
1270 if (!prop_start)
1271 {
1272 // Always search backwards for start when search started
1273 // on a prop and we're not skipping.
1274 if (start_pos_has_prop && !skipstart)
LemonBoy9bd3ce22022-04-18 21:54:02 +01001275 dir = BACKWARD;
Bram Moolenaar4da7a252020-09-02 19:59:00 +02001276 continue;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001277 }
1278
1279 // If skipstart is true, skip the prop at start pos (even if
1280 // continued from another line).
1281 if (start_pos_has_prop && skipstart && !seen_end)
1282 {
1283 start_pos_has_prop = 0;
Bram Moolenaar4da7a252020-09-02 19:59:00 +02001284 continue;
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001285 }
1286
Bram Moolenaare05a89a2020-01-10 19:56:46 +01001287 prop_fill_dict(rettv->vval.v_dict, &prop, buf);
1288 dict_add_number(rettv->vval.v_dict, "lnum", lnum);
1289
1290 return;
1291 }
1292 }
1293
1294 if (dir > 0)
1295 {
1296 if (lnum >= buf->b_ml.ml_line_count)
1297 break;
1298 lnum++;
1299 }
1300 else
1301 {
1302 if (lnum <= 1)
1303 break;
1304 lnum--;
1305 }
1306 }
1307}
1308
1309/*
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001310 * Returns TRUE if 'type_or_id' is in the 'types_or_ids' list.
1311 */
1312 static int
1313prop_type_or_id_in_list(int *types_or_ids, int len, int type_or_id)
1314{
1315 int i;
1316
1317 for (i = 0; i < len; i++)
1318 if (types_or_ids[i] == type_or_id)
1319 return TRUE;
1320
1321 return FALSE;
1322}
1323
1324/*
1325 * Return all the text properties in line 'lnum' in buffer 'buf' in 'retlist'.
1326 * If 'prop_types' is not NULL, then return only the text properties with
1327 * matching property type in the 'prop_types' array.
1328 * If 'prop_ids' is not NULL, then return only the text properties with
1329 * an identifier in the 'props_ids' array.
1330 * If 'add_lnum' is TRUE, then add the line number also to the text property
1331 * dictionary.
1332 */
1333 static void
1334get_props_in_line(
1335 buf_T *buf,
1336 linenr_T lnum,
1337 int *prop_types,
1338 int prop_types_len,
1339 int *prop_ids,
1340 int prop_ids_len,
1341 list_T *retlist,
1342 int add_lnum)
1343{
1344 char_u *text = ml_get_buf(buf, lnum, FALSE);
zeertzjq94b7c322024-03-12 21:50:32 +01001345 size_t textlen = ml_get_buf_len(buf, lnum) + 1;
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001346 int count;
1347 int i;
1348 textprop_T prop;
1349
1350 count = (int)((buf->b_ml.ml_line_len - textlen) / sizeof(textprop_T));
1351 for (i = 0; i < count; ++i)
1352 {
1353 mch_memmove(&prop, text + textlen + i * sizeof(textprop_T),
1354 sizeof(textprop_T));
1355 if ((prop_types == NULL
1356 || prop_type_or_id_in_list(prop_types, prop_types_len,
1357 prop.tp_type))
Bram Moolenaar7f9969c2022-07-25 18:13:54 +01001358 && (prop_ids == NULL
1359 || prop_type_or_id_in_list(prop_ids, prop_ids_len,
1360 prop.tp_id)))
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001361 {
1362 dict_T *d = dict_alloc();
1363
1364 if (d == NULL)
1365 break;
1366 prop_fill_dict(d, &prop, buf);
1367 if (add_lnum)
1368 dict_add_number(d, "lnum", lnum);
1369 list_append_dict(retlist, d);
1370 }
1371 }
1372}
1373
1374/*
1375 * Convert a List of property type names into an array of property type
1376 * identifiers. Returns a pointer to the allocated array. Returns NULL on
1377 * error. 'num_types' is set to the number of returned property types.
1378 */
1379 static int *
1380get_prop_types_from_names(list_T *l, buf_T *buf, int *num_types)
1381{
1382 int *prop_types;
1383 listitem_T *li;
1384 int i;
1385 char_u *name;
1386 proptype_T *type;
1387
1388 *num_types = 0;
1389
1390 prop_types = ALLOC_MULT(int, list_len(l));
1391 if (prop_types == NULL)
1392 return NULL;
1393
1394 i = 0;
1395 FOR_ALL_LIST_ITEMS(l, li)
1396 {
1397 if (li->li_tv.v_type != VAR_STRING)
1398 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001399 emsg(_(e_string_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001400 goto errret;
1401 }
1402 name = li->li_tv.vval.v_string;
1403 if (name == NULL)
1404 goto errret;
1405
1406 type = lookup_prop_type(name, buf);
1407 if (type == NULL)
1408 goto errret;
1409 prop_types[i++] = type->pt_id;
1410 }
1411
1412 *num_types = i;
1413 return prop_types;
1414
1415errret:
1416 VIM_CLEAR(prop_types);
1417 return NULL;
1418}
1419
1420/*
1421 * Convert a List of property identifiers into an array of property
1422 * identifiers. Returns a pointer to the allocated array. Returns NULL on
1423 * error. 'num_ids' is set to the number of returned property identifiers.
1424 */
1425 static int *
1426get_prop_ids_from_list(list_T *l, int *num_ids)
1427{
1428 int *prop_ids;
1429 listitem_T *li;
1430 int i;
1431 int id;
1432 int error;
1433
1434 *num_ids = 0;
1435
1436 prop_ids = ALLOC_MULT(int, list_len(l));
1437 if (prop_ids == NULL)
1438 return NULL;
1439
1440 i = 0;
1441 FOR_ALL_LIST_ITEMS(l, li)
1442 {
1443 error = FALSE;
1444 id = tv_get_number_chk(&li->li_tv, &error);
1445 if (error)
1446 goto errret;
1447
1448 prop_ids[i++] = id;
1449 }
1450
1451 *num_ids = i;
1452 return prop_ids;
1453
1454errret:
1455 VIM_CLEAR(prop_ids);
1456 return NULL;
1457}
1458
1459/*
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001460 * prop_list({lnum} [, {bufnr}])
1461 */
1462 void
1463f_prop_list(typval_T *argvars, typval_T *rettv)
1464{
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001465 linenr_T lnum;
1466 linenr_T start_lnum;
1467 linenr_T end_lnum;
1468 buf_T *buf = curbuf;
1469 int add_lnum = FALSE;
1470 int *prop_types = NULL;
1471 int prop_types_len = 0;
1472 int *prop_ids = NULL;
1473 int prop_ids_len = 0;
1474 list_T *l;
1475 dictitem_T *di;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001476
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001477 if (in_vim9script()
1478 && (check_for_number_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001479 || check_for_opt_dict_arg(argvars, 1) == FAIL))
Yegappan Lakshmanan1a71d312021-07-15 12:49:58 +02001480 return;
1481
Bram Moolenaar93a10962022-06-16 11:42:09 +01001482 if (rettv_list_alloc(rettv) == FAIL)
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001483 return;
1484
1485 // default: get text properties on current line
1486 start_lnum = tv_get_number(&argvars[0]);
1487 end_lnum = start_lnum;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001488 if (argvars[1].v_type != VAR_UNKNOWN)
1489 {
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001490 dict_T *d;
1491
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001492 if (check_for_dict_arg(argvars, 1) == FAIL)
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001493 return;
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001494 d = argvars[1].vval.v_dict;
1495
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001496 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1497 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001498
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001499 if (d != NULL && (di = dict_find(d, (char_u *)"end_lnum", -1)) != NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001500 {
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001501 if (di->di_tv.v_type != VAR_NUMBER)
1502 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001503 emsg(_(e_number_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001504 return;
1505 }
1506 end_lnum = tv_get_number(&di->di_tv);
1507 if (end_lnum < 0)
1508 // negative end_lnum is used as an offset from the last buffer
1509 // line
1510 end_lnum = buf->b_ml.ml_line_count + end_lnum + 1;
1511 else if (end_lnum > buf->b_ml.ml_line_count)
1512 end_lnum = buf->b_ml.ml_line_count;
1513 add_lnum = TRUE;
1514 }
1515 if (d != NULL && (di = dict_find(d, (char_u *)"types", -1)) != NULL)
1516 {
1517 if (di->di_tv.v_type != VAR_LIST)
1518 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001519 emsg(_(e_list_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001520 return;
1521 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001522
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001523 l = di->di_tv.vval.v_list;
1524 if (l != NULL && list_len(l) > 0)
1525 {
1526 prop_types = get_prop_types_from_names(l, buf, &prop_types_len);
1527 if (prop_types == NULL)
1528 return;
1529 }
1530 }
1531 if (d != NULL && (di = dict_find(d, (char_u *)"ids", -1)) != NULL)
1532 {
1533 if (di->di_tv.v_type != VAR_LIST)
1534 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001535 emsg(_(e_list_required));
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001536 goto errret;
1537 }
1538
1539 l = di->di_tv.vval.v_list;
1540 if (l != NULL && list_len(l) > 0)
1541 {
1542 prop_ids = get_prop_ids_from_list(l, &prop_ids_len);
1543 if (prop_ids == NULL)
1544 goto errret;
1545 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001546 }
1547 }
Yegappan Lakshmanane0216622021-11-23 11:46:32 +00001548 if (start_lnum < 1 || start_lnum > buf->b_ml.ml_line_count
1549 || end_lnum < 1 || end_lnum < start_lnum)
1550 emsg(_(e_invalid_range));
1551 else
1552 for (lnum = start_lnum; lnum <= end_lnum; lnum++)
1553 get_props_in_line(buf, lnum, prop_types, prop_types_len,
1554 prop_ids, prop_ids_len,
1555 rettv->vval.v_list, add_lnum);
1556
1557errret:
1558 VIM_CLEAR(prop_types);
1559 VIM_CLEAR(prop_ids);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001560}
1561
1562/*
1563 * prop_remove({props} [, {lnum} [, {lnum_end}]])
1564 */
1565 void
1566f_prop_remove(typval_T *argvars, typval_T *rettv)
1567{
1568 linenr_T start = 1;
1569 linenr_T end = 0;
1570 linenr_T lnum;
Bram Moolenaar965c0442021-05-17 00:22:06 +02001571 linenr_T first_changed = 0;
1572 linenr_T last_changed = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001573 dict_T *dict;
1574 buf_T *buf = curbuf;
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001575 int do_all;
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001576 int id = -MAXCOL;
Ben Jacksona7704222022-08-20 20:54:51 +01001577 int type_id = -1; // for a single "type"
1578 int *type_ids = NULL; // array, for a list of "types", allocated
1579 int num_type_ids = 0; // number of elements in "type_ids"
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001580 int both;
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001581 int did_remove_text = FALSE;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001582
1583 rettv->vval.v_number = 0;
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02001584
1585 if (in_vim9script()
1586 && (check_for_dict_arg(argvars, 0) == FAIL
1587 || check_for_opt_number_arg(argvars, 1) == FAIL
1588 || (argvars[1].v_type != VAR_UNKNOWN
1589 && check_for_opt_number_arg(argvars, 2) == FAIL)))
1590 return;
1591
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001592 if (check_for_nonnull_dict_arg(argvars, 0) == FAIL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001593 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001594
1595 if (argvars[1].v_type != VAR_UNKNOWN)
1596 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001597 start = tv_get_number(&argvars[1]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001598 end = start;
1599 if (argvars[2].v_type != VAR_UNKNOWN)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001600 end = tv_get_number(&argvars[2]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001601 if (start < 1 || end < 1)
1602 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001603 emsg(_(e_invalid_range));
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001604 return;
1605 }
1606 }
1607
1608 dict = argvars[0].vval.v_dict;
Bram Moolenaarf0884c52019-05-24 21:22:29 +02001609 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
1610 return;
1611 if (buf->b_ml.ml_mfp == NULL)
1612 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001613
Bram Moolenaard61efa52022-07-23 09:52:04 +01001614 do_all = dict_get_bool(dict, "all", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001615
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001616 if (dict_has_key(dict, "id"))
Bram Moolenaard61efa52022-07-23 09:52:04 +01001617 id = dict_get_number(dict, "id");
Ben Jacksona7704222022-08-20 20:54:51 +01001618
1619 // if a specific type was supplied "type": check that (and ignore "types".
1620 // Otherwise check against the list of "types".
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01001621 if (dict_has_key(dict, "type"))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001622 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01001623 char_u *name = dict_get_string(dict, "type", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001624 proptype_T *type = lookup_prop_type(name, buf);
1625
1626 if (type == NULL)
1627 return;
1628 type_id = type->pt_id;
1629 }
Ben Jacksona7704222022-08-20 20:54:51 +01001630 if (dict_has_key(dict, "types"))
1631 {
1632 typval_T types;
1633 listitem_T *li = NULL;
1634
1635 dict_get_tv(dict, "types", &types);
1636 if (types.v_type == VAR_LIST && types.vval.v_list->lv_len > 0)
1637 {
1638 type_ids = alloc( sizeof(int) * types.vval.v_list->lv_len );
1639
1640 FOR_ALL_LIST_ITEMS(types.vval.v_list, li)
1641 {
1642 proptype_T *prop_type;
1643
1644 if (li->li_tv.v_type != VAR_STRING)
1645 continue;
1646
1647 prop_type = lookup_prop_type(li->li_tv.vval.v_string, buf);
1648
1649 if (!prop_type)
1650 goto cleanup_prop_remove;
1651
1652 type_ids[num_type_ids++] = prop_type->pt_id;
1653 }
1654 }
1655 }
Bram Moolenaard61efa52022-07-23 09:52:04 +01001656 both = dict_get_bool(dict, "both", FALSE);
Bram Moolenaara5a40c52020-09-05 20:50:49 +02001657
Ben Jacksona7704222022-08-20 20:54:51 +01001658 if (id == -MAXCOL && (type_id == -1 && num_type_ids == 0))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001659 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001660 emsg(_(e_need_at_least_one_of_id_or_type));
Ben Jacksona7704222022-08-20 20:54:51 +01001661 goto cleanup_prop_remove;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001662 }
Ben Jacksona7704222022-08-20 20:54:51 +01001663 if (both && (id == -MAXCOL || (type_id == -1 && num_type_ids == 0)))
Bram Moolenaar49b79bd2020-03-05 21:52:55 +01001664 {
Ben Jacksona7704222022-08-20 20:54:51 +01001665 emsg(_(e_need_id_and_type_or_types_with_both));
1666 goto cleanup_prop_remove;
1667 }
1668 if (type_id != -1 && num_type_ids > 0)
1669 {
1670 emsg(_(e_cannot_specify_both_type_and_types));
1671 goto cleanup_prop_remove;
Bram Moolenaar49b79bd2020-03-05 21:52:55 +01001672 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001673
1674 if (end == 0)
1675 end = buf->b_ml.ml_line_count;
1676 for (lnum = start; lnum <= end; ++lnum)
1677 {
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001678 size_t len;
1679
1680 if (lnum > buf->b_ml.ml_line_count)
1681 break;
zeertzjq94b7c322024-03-12 21:50:32 +01001682 len = ml_get_buf_len(buf, lnum) + 1;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001683 if ((size_t)buf->b_ml.ml_line_len > len)
1684 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02001685 static textprop_T textprop; // static because of alignment
1686 unsigned idx;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001687
1688 for (idx = 0; idx < (buf->b_ml.ml_line_len - len)
1689 / sizeof(textprop_T); ++idx)
1690 {
1691 char_u *cur_prop = buf->b_ml.ml_line_ptr + len
1692 + idx * sizeof(textprop_T);
1693 size_t taillen;
Ben Jacksona7704222022-08-20 20:54:51 +01001694 int matches_id = 0;
1695 int matches_type = 0;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001696
1697 mch_memmove(&textprop, cur_prop, sizeof(textprop_T));
Ben Jacksona7704222022-08-20 20:54:51 +01001698
1699 matches_id = textprop.tp_id == id;
1700 if (num_type_ids > 0)
1701 {
1702 int idx2;
1703
1704 for (idx2 = 0; !matches_type && idx2 < num_type_ids; ++idx2)
1705 matches_type = textprop.tp_type == type_ids[idx2];
1706 }
1707 else
1708 {
1709 matches_type = textprop.tp_type == type_id;
1710 }
1711
1712 if (both ? matches_id && matches_type
1713 : matches_id || matches_type)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001714 {
1715 if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY))
1716 {
1717 char_u *newptr = alloc(buf->b_ml.ml_line_len);
1718
1719 // need to allocate the line to be able to change it
1720 if (newptr == NULL)
Ben Jacksona7704222022-08-20 20:54:51 +01001721 goto cleanup_prop_remove;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001722 mch_memmove(newptr, buf->b_ml.ml_line_ptr,
1723 buf->b_ml.ml_line_len);
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01001724 if (buf->b_ml.ml_flags & ML_ALLOCATED)
1725 vim_free(buf->b_ml.ml_line_ptr);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001726 buf->b_ml.ml_line_ptr = newptr;
Bram Moolenaar0a2f5782019-03-22 13:20:43 +01001727 buf->b_ml.ml_flags |= ML_LINE_DIRTY;
1728
1729 cur_prop = buf->b_ml.ml_line_ptr + len
Bram Moolenaarf0884c52019-05-24 21:22:29 +02001730 + idx * sizeof(textprop_T);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001731 }
1732
1733 taillen = buf->b_ml.ml_line_len - len
1734 - (idx + 1) * sizeof(textprop_T);
1735 if (taillen > 0)
1736 mch_memmove(cur_prop, cur_prop + sizeof(textprop_T),
1737 taillen);
1738 buf->b_ml.ml_line_len -= sizeof(textprop_T);
1739 --idx;
1740
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001741 if (textprop.tp_id < 0)
1742 {
1743 garray_T *gap = &buf->b_textprop_text;
1744 int ii = -textprop.tp_id - 1;
1745
1746 // negative ID: property with text - free the text
1747 if (ii < gap->ga_len)
1748 {
1749 char_u **p = ((char_u **)gap->ga_data) + ii;
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00001750 VIM_CLEAR(*p);
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001751 did_remove_text = TRUE;
1752 }
1753 }
1754
Bram Moolenaar965c0442021-05-17 00:22:06 +02001755 if (first_changed == 0)
1756 first_changed = lnum;
1757 last_changed = lnum;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001758 ++rettv->vval.v_number;
1759 if (!do_all)
1760 break;
1761 }
1762 }
1763 }
1764 }
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001765
Bram Moolenaar965c0442021-05-17 00:22:06 +02001766 if (first_changed > 0)
Bram Moolenaarfc643e62021-05-17 00:15:18 +02001767 {
Bram Moolenaar326c5d32022-08-12 13:05:49 +01001768 changed_line_display_buf(buf);
Bram Moolenaar965c0442021-05-17 00:22:06 +02001769 changed_lines_buf(buf, first_changed, last_changed + 1, 0);
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001770 redraw_buf_later(buf, UPD_VALID);
Bram Moolenaarfc643e62021-05-17 00:15:18 +02001771 }
Bram Moolenaar3a4cd392022-07-30 22:17:18 +01001772
1773 if (did_remove_text)
1774 {
1775 garray_T *gap = &buf->b_textprop_text;
1776
1777 // Reduce the growarray size for NULL pointers at the end.
1778 while (gap->ga_len > 0
1779 && ((char_u **)gap->ga_data)[gap->ga_len - 1] == NULL)
1780 --gap->ga_len;
1781 }
Ben Jacksona7704222022-08-20 20:54:51 +01001782
1783cleanup_prop_remove:
1784 vim_free(type_ids);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001785}
1786
1787/*
1788 * Common for f_prop_type_add() and f_prop_type_change().
1789 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001790 static void
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001791prop_type_set(typval_T *argvars, int add)
1792{
1793 char_u *name;
1794 buf_T *buf = NULL;
1795 dict_T *dict;
1796 dictitem_T *di;
1797 proptype_T *prop;
1798
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001799 if (in_vim9script()
1800 && (check_for_string_arg(argvars, 0) == FAIL
1801 || check_for_dict_arg(argvars, 1) == FAIL))
1802 return;
1803
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001804 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001805 if (*name == NUL)
1806 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00001807 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001808 return;
1809 }
1810
1811 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1812 return;
1813 dict = argvars[1].vval.v_dict;
1814
Bram Moolenaare44336b2022-08-07 18:20:08 +01001815 prop = find_prop_type(name, buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001816 if (add)
1817 {
1818 hashtab_T **htp;
1819
1820 if (prop != NULL)
1821 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001822 semsg(_(e_property_type_str_already_defined), name);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001823 return;
1824 }
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001825 prop = alloc_clear(offsetof(proptype_T, pt_name) + STRLEN(name) + 1);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001826 if (prop == NULL)
1827 return;
1828 STRCPY(prop->pt_name, name);
1829 prop->pt_id = ++proptype_id;
Bram Moolenaar0743ef92019-11-13 16:37:31 +01001830 prop->pt_flags = PT_FLAG_COMBINE;
Bram Moolenaare44336b2022-08-07 18:20:08 +01001831 if (buf == NULL)
1832 {
1833 htp = &global_proptypes;
1834 VIM_CLEAR(global_proparray);
1835 }
1836 else
1837 {
1838 htp = &buf->b_proptypes;
1839 VIM_CLEAR(buf->b_proparray);
1840 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001841 if (*htp == NULL)
1842 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001843 *htp = ALLOC_ONE(hashtab_T);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001844 if (*htp == NULL)
Bram Moolenaarfb95e212018-12-14 12:18:11 +01001845 {
1846 vim_free(prop);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001847 return;
Bram Moolenaarfb95e212018-12-14 12:18:11 +01001848 }
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001849 hash_init(*htp);
1850 }
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001851 hash_add(*htp, PT2HIKEY(prop), "prop type");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001852 }
1853 else
1854 {
1855 if (prop == NULL)
1856 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001857 semsg(_(e_property_type_str_does_not_exist), name);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001858 return;
1859 }
1860 }
1861
1862 if (dict != NULL)
1863 {
1864 di = dict_find(dict, (char_u *)"highlight", -1);
1865 if (di != NULL)
1866 {
1867 char_u *highlight;
1868 int hl_id = 0;
1869
Bram Moolenaard61efa52022-07-23 09:52:04 +01001870 highlight = dict_get_string(dict, "highlight", FALSE);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001871 if (highlight != NULL && *highlight != NUL)
1872 hl_id = syn_name2id(highlight);
1873 if (hl_id <= 0)
1874 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001875 semsg(_(e_unknown_highlight_group_name_str),
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001876 highlight == NULL ? (char_u *)"" : highlight);
1877 return;
1878 }
1879 prop->pt_hl_id = hl_id;
1880 }
1881
Bram Moolenaar58187f12019-05-05 16:33:47 +02001882 di = dict_find(dict, (char_u *)"combine", -1);
1883 if (di != NULL)
1884 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001885 if (tv_get_bool(&di->di_tv))
Bram Moolenaar58187f12019-05-05 16:33:47 +02001886 prop->pt_flags |= PT_FLAG_COMBINE;
1887 else
1888 prop->pt_flags &= ~PT_FLAG_COMBINE;
1889 }
1890
Bram Moolenaarf4ba8bc2022-08-05 17:05:04 +01001891 di = dict_find(dict, (char_u *)"override", -1);
1892 if (di != NULL)
1893 {
1894 if (tv_get_bool(&di->di_tv))
1895 prop->pt_flags |= PT_FLAG_OVERRIDE;
1896 else
1897 prop->pt_flags &= ~PT_FLAG_OVERRIDE;
1898 }
1899
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001900 di = dict_find(dict, (char_u *)"priority", -1);
1901 if (di != NULL)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001902 prop->pt_priority = tv_get_number(&di->di_tv);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001903
1904 di = dict_find(dict, (char_u *)"start_incl", -1);
1905 if (di != NULL)
1906 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001907 if (tv_get_bool(&di->di_tv))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001908 prop->pt_flags |= PT_FLAG_INS_START_INCL;
1909 else
1910 prop->pt_flags &= ~PT_FLAG_INS_START_INCL;
1911 }
1912
1913 di = dict_find(dict, (char_u *)"end_incl", -1);
1914 if (di != NULL)
1915 {
Bram Moolenaarfa2e38d2020-09-05 21:00:00 +02001916 if (tv_get_bool(&di->di_tv))
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001917 prop->pt_flags |= PT_FLAG_INS_END_INCL;
1918 else
1919 prop->pt_flags &= ~PT_FLAG_INS_END_INCL;
1920 }
1921 }
1922}
1923
1924/*
1925 * prop_type_add({name}, {props})
1926 */
1927 void
1928f_prop_type_add(typval_T *argvars, typval_T *rettv UNUSED)
1929{
1930 prop_type_set(argvars, TRUE);
1931}
1932
1933/*
1934 * prop_type_change({name}, {props})
1935 */
1936 void
1937f_prop_type_change(typval_T *argvars, typval_T *rettv UNUSED)
1938{
1939 prop_type_set(argvars, FALSE);
1940}
1941
1942/*
1943 * prop_type_delete({name} [, {bufnr}])
1944 */
1945 void
1946f_prop_type_delete(typval_T *argvars, typval_T *rettv UNUSED)
1947{
1948 char_u *name;
1949 buf_T *buf = NULL;
1950 hashitem_T *hi;
1951
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02001952 if (in_vim9script()
1953 && (check_for_string_arg(argvars, 0) == FAIL
1954 || check_for_opt_dict_arg(argvars, 1) == FAIL))
1955 return;
1956
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001957 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001958 if (*name == NUL)
1959 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00001960 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001961 return;
1962 }
1963
1964 if (argvars[1].v_type != VAR_UNKNOWN)
1965 {
1966 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
1967 return;
1968 }
1969
Bram Moolenaare44336b2022-08-07 18:20:08 +01001970 hi = find_prop_type_hi(name, buf);
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001971 if (hi == NULL)
1972 return;
1973
1974 hashtab_T *ht;
1975 proptype_T *prop = HI2PT(hi);
1976
1977 if (buf == NULL)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001978 {
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001979 ht = global_proptypes;
1980 VIM_CLEAR(global_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001981 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001982 else
1983 {
1984 ht = buf->b_proptypes;
1985 VIM_CLEAR(buf->b_proparray);
1986 }
1987 hash_remove(ht, hi, "prop type delete");
1988 vim_free(prop);
1989
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001990 // currently visible text properties will disappear
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00001991 redraw_all_later(UPD_CLEAR);
1992 changed_window_setting_buf(buf == NULL ? curbuf : buf);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001993}
1994
1995/*
Martin Tournoije2390c72021-07-28 13:30:16 +02001996 * prop_type_get({name} [, {props}])
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001997 */
1998 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01001999f_prop_type_get(typval_T *argvars, typval_T *rettv)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002000{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002001 char_u *name;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002002
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002003 if (in_vim9script()
2004 && (check_for_string_arg(argvars, 0) == FAIL
2005 || check_for_opt_dict_arg(argvars, 1) == FAIL))
2006 return;
2007
2008 name = tv_get_string(&argvars[0]);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002009 if (*name == NUL)
2010 {
Bram Moolenaar89469d12022-12-02 20:46:26 +00002011 semsg(_(e_invalid_argument_str), "\"\"");
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002012 return;
2013 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002014
2015 if (rettv_dict_alloc(rettv) == FAIL)
2016 return;
2017
2018 proptype_T *prop = NULL;
2019 buf_T *buf = NULL;
2020
2021 if (argvars[1].v_type != VAR_UNKNOWN)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002022 {
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002023 if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL)
2024 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002025 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002026
2027 prop = find_prop_type(name, buf);
2028 if (prop == NULL)
2029 return;
2030
2031 dict_T *d = rettv->vval.v_dict;
2032
2033 if (prop->pt_hl_id > 0)
2034 dict_add_string(d, "highlight", syn_id2name(prop->pt_hl_id));
2035 dict_add_number(d, "priority", prop->pt_priority);
2036 dict_add_number(d, "combine",
2037 (prop->pt_flags & PT_FLAG_COMBINE) ? 1 : 0);
2038 dict_add_number(d, "start_incl",
2039 (prop->pt_flags & PT_FLAG_INS_START_INCL) ? 1 : 0);
2040 dict_add_number(d, "end_incl",
2041 (prop->pt_flags & PT_FLAG_INS_END_INCL) ? 1 : 0);
2042 if (buf != NULL)
2043 dict_add_number(d, "bufnr", buf->b_fnum);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002044}
2045
2046 static void
2047list_types(hashtab_T *ht, list_T *l)
2048{
2049 long todo;
2050 hashitem_T *hi;
2051
2052 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002053 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002054 {
2055 if (!HASHITEM_EMPTY(hi))
2056 {
2057 proptype_T *prop = HI2PT(hi);
2058
2059 list_append_string(l, prop->pt_name, -1);
2060 --todo;
2061 }
2062 }
2063}
2064
2065/*
2066 * prop_type_list([{bufnr}])
2067 */
2068 void
2069f_prop_type_list(typval_T *argvars, typval_T *rettv UNUSED)
2070{
2071 buf_T *buf = NULL;
2072
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002073 if (rettv_list_alloc(rettv) == FAIL)
2074 return;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02002075
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002076 if (in_vim9script() && check_for_opt_dict_arg(argvars, 0) == FAIL)
2077 return;
2078
2079 if (argvars[0].v_type != VAR_UNKNOWN)
2080 {
2081 if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL)
2082 return;
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002083 }
Yegappan Lakshmanan032713f2023-01-25 21:05:38 +00002084 if (buf == NULL)
2085 {
2086 if (global_proptypes != NULL)
2087 list_types(global_proptypes, rettv->vval.v_list);
2088 }
2089 else if (buf->b_proptypes != NULL)
2090 list_types(buf->b_proptypes, rettv->vval.v_list);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002091}
2092
2093/*
2094 * Free all property types in "ht".
2095 */
2096 static void
2097clear_ht_prop_types(hashtab_T *ht)
2098{
2099 long todo;
2100 hashitem_T *hi;
2101
2102 if (ht == NULL)
2103 return;
2104
2105 todo = (long)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002106 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002107 {
2108 if (!HASHITEM_EMPTY(hi))
2109 {
2110 proptype_T *prop = HI2PT(hi);
2111
2112 vim_free(prop);
2113 --todo;
2114 }
2115 }
2116
2117 hash_clear(ht);
2118 vim_free(ht);
2119}
2120
2121#if defined(EXITFREE) || defined(PROTO)
2122/*
Bram Moolenaarfb95e212018-12-14 12:18:11 +01002123 * Free all global property types.
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002124 */
2125 void
2126clear_global_prop_types(void)
2127{
2128 clear_ht_prop_types(global_proptypes);
2129 global_proptypes = NULL;
Bram Moolenaare44336b2022-08-07 18:20:08 +01002130 VIM_CLEAR(global_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002131}
2132#endif
2133
2134/*
2135 * Free all property types for "buf".
2136 */
2137 void
2138clear_buf_prop_types(buf_T *buf)
2139{
2140 clear_ht_prop_types(buf->b_proptypes);
2141 buf->b_proptypes = NULL;
Bram Moolenaare44336b2022-08-07 18:20:08 +01002142 VIM_CLEAR(buf->b_proparray);
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002143}
2144
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002145// Struct used to return two values from adjust_prop().
2146typedef struct
2147{
2148 int dirty; // if the property was changed
2149 int can_drop; // whether after this change, the prop may be removed
2150} adjustres_T;
2151
2152/*
2153 * Adjust the property for "added" bytes (can be negative) inserted at "col".
2154 *
2155 * Note that "col" is zero-based, while tp_col is one-based.
2156 * Only for the current buffer.
2157 * "flags" can have:
2158 * APC_SUBSTITUTE: Text is replaced, not inserted.
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002159 * APC_INDENT: Text is inserted before virtual text prop
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002160 */
2161 static adjustres_T
2162adjust_prop(
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002163 textprop_T *prop,
2164 colnr_T col,
2165 int added,
2166 int flags)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002167{
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002168 proptype_T *pt;
2169 int start_incl;
2170 int end_incl;
2171 int droppable;
2172 adjustres_T res = {TRUE, FALSE};
2173
2174 // prop after end of the line doesn't move
2175 if (prop->tp_col == MAXCOL)
2176 {
2177 res.dirty = FALSE;
2178 return res;
2179 }
2180
2181 pt = text_prop_type_by_id(curbuf, prop->tp_type);
2182 start_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_START_INCL))
LemonBoy698cb4c2022-05-14 18:10:15 +01002183 || (flags & APC_SUBSTITUTE)
2184 || (prop->tp_flags & TP_FLAG_CONT_PREV);
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002185 if (prop->tp_id < 0 && (flags & APC_INDENT))
2186 // when inserting indent just before a character with virtual text
2187 // shift the text property
2188 start_incl = FALSE;
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002189 end_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_END_INCL))
LemonBoy698cb4c2022-05-14 18:10:15 +01002190 || (prop->tp_flags & TP_FLAG_CONT_NEXT);
Bram Moolenaarb7963df2022-07-31 17:12:43 +01002191 // do not drop zero-width props if they later can increase in size
2192 droppable = !(start_incl || end_incl);
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002193
2194 if (added > 0)
2195 {
2196 if (col + 1 <= prop->tp_col
2197 - (start_incl || (prop->tp_len == 0 && end_incl)))
2198 // Change is entirely before the text property: Only shift
2199 prop->tp_col += added;
2200 else if (col + 1 < prop->tp_col + prop->tp_len + end_incl)
2201 // Insertion was inside text property
2202 prop->tp_len += added;
2203 }
2204 else if (prop->tp_col > col + 1)
2205 {
2206 if (prop->tp_col + added < col + 1)
2207 {
2208 prop->tp_len += (prop->tp_col - 1 - col) + added;
2209 prop->tp_col = col + 1;
2210 if (prop->tp_len <= 0)
2211 {
2212 prop->tp_len = 0;
2213 res.can_drop = droppable;
2214 }
2215 }
2216 else
2217 prop->tp_col += added;
2218 }
Bram Moolenaarf5240b92022-08-24 12:24:37 +01002219 else if (prop->tp_len > 0 && prop->tp_col + prop->tp_len > col
2220 && prop->tp_id >= 0) // don't change length for virtual text
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002221 {
2222 int after = col - added - (prop->tp_col - 1 + prop->tp_len);
2223
2224 prop->tp_len += after > 0 ? added + after : added;
2225 res.can_drop = prop->tp_len <= 0 && droppable;
2226 }
2227 else
2228 res.dirty = FALSE;
2229
2230 return res;
2231}
2232
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002233/*
2234 * Adjust the columns of text properties in line "lnum" after position "col" to
2235 * shift by "bytes_added" (can be negative).
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002236 * Note that "col" is zero-based, while tp_col is one-based.
2237 * Only for the current buffer.
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002238 * "flags" can have:
2239 * APC_SAVE_FOR_UNDO: Call u_savesub() before making changes to the line.
2240 * APC_SUBSTITUTE: Text is replaced, not inserted.
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002241 * APC_INDENT: Text is inserted before virtual text prop
Bram Moolenaar8055d172019-05-17 22:57:26 +02002242 * Caller is expected to check b_has_textprop and "bytes_added" being non-zero.
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002243 * Returns TRUE when props were changed.
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002244 */
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002245 int
Bram Moolenaar196d1572019-01-02 23:47:18 +01002246adjust_prop_columns(
2247 linenr_T lnum,
2248 colnr_T col,
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002249 int bytes_added,
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002250 int flags)
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002251{
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002252 int proplen;
2253 char_u *props;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002254 int dirty = FALSE;
Bram Moolenaar196d1572019-01-02 23:47:18 +01002255 int ri, wi;
2256 size_t textlen;
2257
2258 if (text_prop_frozen > 0)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002259 return FALSE;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002260
2261 proplen = get_text_props(curbuf, lnum, &props, TRUE);
2262 if (proplen == 0)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002263 return FALSE;
Bram Moolenaar196d1572019-01-02 23:47:18 +01002264 textlen = curbuf->b_ml.ml_line_len - proplen * sizeof(textprop_T);
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002265
Bram Moolenaar196d1572019-01-02 23:47:18 +01002266 wi = 0; // write index
2267 for (ri = 0; ri < proplen; ++ri)
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002268 {
Bram Moolenaar12f20032020-02-26 22:06:00 +01002269 textprop_T prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002270 adjustres_T res;
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002271
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002272 mch_memmove(&prop, props + ri * sizeof(prop), sizeof(prop));
2273 res = adjust_prop(&prop, col, bytes_added, flags);
2274 if (res.dirty)
Bram Moolenaarf3333b02019-05-19 22:53:40 +02002275 {
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002276 // Save for undo if requested and not done yet.
Bram Moolenaarcf070112020-06-29 23:02:21 +02002277 if ((flags & APC_SAVE_FOR_UNDO) && !dirty
2278 && u_savesub(lnum) == FAIL)
2279 return FALSE;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002280 dirty = TRUE;
Bram Moolenaar8902b312020-09-20 21:04:35 +02002281
2282 // u_savesub() may have updated curbuf->b_ml, fetch it again
2283 if (curbuf->b_ml.ml_line_lnum != lnum)
2284 proplen = get_text_props(curbuf, lnum, &props, TRUE);
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002285 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002286 if (res.can_drop)
2287 continue; // Drop this text property
Bram Moolenaar12f20032020-02-26 22:06:00 +01002288 mch_memmove(props + wi * sizeof(textprop_T), &prop, sizeof(textprop_T));
Bram Moolenaar196d1572019-01-02 23:47:18 +01002289 ++wi;
2290 }
2291 if (dirty)
2292 {
Bram Moolenaar4614f532019-01-06 12:54:55 +01002293 colnr_T newlen = (int)textlen + wi * (colnr_T)sizeof(textprop_T);
2294
2295 if ((curbuf->b_ml.ml_flags & ML_LINE_DIRTY) == 0)
Bram Moolenaarfa4873c2022-06-30 22:13:59 +01002296 {
2297 char_u *p = vim_memsave(curbuf->b_ml.ml_line_ptr, newlen);
2298
2299 if (curbuf->b_ml.ml_flags & ML_ALLOCATED)
2300 vim_free(curbuf->b_ml.ml_line_ptr);
2301 curbuf->b_ml.ml_line_ptr = p;
2302 }
Bram Moolenaar196d1572019-01-02 23:47:18 +01002303 curbuf->b_ml.ml_flags |= ML_LINE_DIRTY;
Bram Moolenaar4614f532019-01-06 12:54:55 +01002304 curbuf->b_ml.ml_line_len = newlen;
Bram Moolenaar44746aa2019-01-02 00:02:11 +01002305 }
Bram Moolenaar338dfda2019-05-19 15:19:57 +02002306 return dirty;
Bram Moolenaarb9c67a52019-01-01 19:49:20 +01002307}
2308
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002309/*
2310 * Adjust text properties for a line that was split in two.
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002311 * "lnum_props" is the line that has the properties from before the split.
2312 * "lnum_top" is the top line.
2313 * "kept" is the number of bytes kept in the first line, while
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002314 * "deleted" is the number of bytes deleted.
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002315 * "at_eol" is true if the split is after the end of the line.
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002316 */
2317 void
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002318adjust_props_for_split(
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002319 linenr_T lnum_props,
2320 linenr_T lnum_top,
2321 int kept,
2322 int deleted,
2323 int at_eol)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002324{
2325 char_u *props;
2326 int count;
2327 garray_T prevprop;
2328 garray_T nextprop;
2329 int i;
2330 int skipped = kept + deleted;
2331
2332 if (!curbuf->b_has_textprop)
2333 return;
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002334
2335 // Get the text properties from "lnum_props".
2336 count = get_text_props(curbuf, lnum_props, &props, FALSE);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002337 ga_init2(&prevprop, sizeof(textprop_T), 10);
2338 ga_init2(&nextprop, sizeof(textprop_T), 10);
2339
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002340 // Keep the relevant ones in the first line, reducing the length if needed.
2341 // Copy the ones that include the split to the second line.
2342 // Move the ones after the split to the second line.
2343 for (i = 0; i < count; ++i)
2344 {
2345 textprop_T prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002346 proptype_T *pt;
2347 int start_incl, end_incl;
2348 int cont_prev, cont_next;
Bram Moolenaar3b93cf22022-09-13 18:34:18 +01002349 int prop_col;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002350
2351 // copy the prop to an aligned structure
2352 mch_memmove(&prop, props + i * sizeof(textprop_T), sizeof(textprop_T));
2353
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002354 pt = text_prop_type_by_id(curbuf, prop.tp_type);
2355 start_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_START_INCL));
2356 end_incl = (pt != NULL && (pt->pt_flags & PT_FLAG_INS_END_INCL));
Bram Moolenaar3b93cf22022-09-13 18:34:18 +01002357
2358 // a text prop "above" behaves like it is on the first text column
2359 prop_col = (prop.tp_flags & TP_FLAG_ALIGN_ABOVE) ? 1 : prop.tp_col;
2360
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002361 if (prop_col == MAXCOL)
2362 {
2363 cont_prev = at_eol;
2364 cont_next = !at_eol;
2365 }
2366 else
2367 {
2368 cont_prev = prop_col + !start_incl <= kept;
2369 cont_next = skipped <= prop_col + prop.tp_len - !end_incl;
2370 }
Bram Moolenaard8d4cfc2022-08-15 15:55:10 +01002371 // when a prop has text it is never copied
2372 if (prop.tp_id < 0 && cont_next)
2373 cont_prev = FALSE;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002374
2375 if (cont_prev && ga_grow(&prevprop, 1) == OK)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002376 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002377 textprop_T *p = ((textprop_T *)prevprop.ga_data) + prevprop.ga_len;
2378
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002379 *p = prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002380 ++prevprop.ga_len;
Bram Moolenaar98b37302022-09-14 12:06:53 +01002381 if (p->tp_col != MAXCOL && p->tp_col + p->tp_len >= kept)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002382 p->tp_len = kept - p->tp_col;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002383 if (cont_next)
2384 p->tp_flags |= TP_FLAG_CONT_NEXT;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002385 }
2386
Bram Moolenaar5c65e6a2019-05-17 11:08:56 +02002387 // Only add the property to the next line if the length is bigger than
2388 // zero.
Bram Moolenaarebd0e8b2022-09-14 22:13:59 +01002389 if (cont_next && ga_grow(&nextprop, 1) == OK)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002390 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002391 textprop_T *p = ((textprop_T *)nextprop.ga_data) + nextprop.ga_len;
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002392
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002393 *p = prop;
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002394 ++nextprop.ga_len;
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002395 if (p->tp_col != MAXCOL)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002396 {
Bram Moolenaar7d0f7e92022-08-06 17:10:57 +01002397 if (p->tp_col > skipped)
2398 p->tp_col -= skipped - 1;
2399 else
2400 {
2401 p->tp_len -= skipped - p->tp_col;
2402 p->tp_col = 1;
2403 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002404 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002405 if (cont_prev)
2406 p->tp_flags |= TP_FLAG_CONT_PREV;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002407 }
2408 }
2409
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002410 set_text_props(lnum_top, prevprop.ga_data,
2411 prevprop.ga_len * sizeof(textprop_T));
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002412 ga_clear(&prevprop);
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02002413 set_text_props(lnum_top + 1, nextprop.ga_data,
2414 nextprop.ga_len * sizeof(textprop_T));
Bram Moolenaar4164bb22019-01-04 23:09:49 +01002415 ga_clear(&nextprop);
2416}
2417
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002418/*
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002419 * Prepend properties of joined line "lnum" to "new_props".
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002420 */
2421 void
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002422prepend_joined_props(
2423 char_u *new_props,
2424 int propcount,
2425 int *props_remaining,
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002426 linenr_T lnum,
Bram Moolenaare175dc62022-08-01 22:18:50 +01002427 int last_line,
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002428 long col,
2429 int removed)
2430{
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002431 char_u *props;
2432 int proplen = get_text_props(curbuf, lnum, &props, FALSE);
2433 int i;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002434
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002435 for (i = proplen; i-- > 0; )
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002436 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002437 textprop_T prop;
2438 int end;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002439
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002440 mch_memmove(&prop, props + i * sizeof(prop), sizeof(prop));
Bram Moolenaare175dc62022-08-01 22:18:50 +01002441 if (prop.tp_col == MAXCOL && !last_line)
2442 continue; // drop property with text after the line
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002443 end = !(prop.tp_flags & TP_FLAG_CONT_NEXT);
2444
2445 adjust_prop(&prop, 0, -removed, 0); // Remove leading spaces
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002446 adjust_prop(&prop, -1, col, 0); // Make line start at its final column
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002447
Bram Moolenaare175dc62022-08-01 22:18:50 +01002448 if (last_line || end)
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002449 mch_memmove(new_props + --(*props_remaining) * sizeof(prop),
2450 &prop, sizeof(prop));
2451 else
2452 {
2453 int j;
2454 int found = FALSE;
2455
2456 // Search for continuing prop.
2457 for (j = *props_remaining; j < propcount; ++j)
2458 {
2459 textprop_T op;
2460
2461 mch_memmove(&op, new_props + j * sizeof(op), sizeof(op));
2462 if ((op.tp_flags & TP_FLAG_CONT_PREV)
2463 && op.tp_id == prop.tp_id && op.tp_type == prop.tp_type)
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002464 {
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002465 found = TRUE;
2466 op.tp_len += op.tp_col - prop.tp_col;
2467 op.tp_col = prop.tp_col;
2468 // Start/end is taken care of when deleting joined lines
2469 op.tp_flags = prop.tp_flags;
2470 mch_memmove(new_props + j * sizeof(op), &op, sizeof(op));
2471 break;
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002472 }
2473 }
Bram Moolenaar87be9be2020-05-30 15:32:02 +02002474 if (!found)
2475 internal_error("text property above joined line not found");
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002476 }
Bram Moolenaar80e737c2019-05-17 19:56:34 +02002477 }
2478}
2479
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002480#endif // FEAT_PROP_POPUP