Mercurial > vim
view src/textprop.c @ 15138:9df130fd5e0d v8.1.0579
patch 8.1.0579: cannot attach properties to text
commit https://github.com/vim/vim/commit/98aefe7c3250bb5d4153b994f878594d1745424e
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Dec 13 22:20:09 2018 +0100
patch 8.1.0579: cannot attach properties to text
Problem: Cannot attach properties to text.
Solution: First part of adding text properties.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Thu, 13 Dec 2018 22:30:08 +0100 |
parents | |
children | 7960bf50d345 |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * Text properties implementation. * * Text properties are attached to the text. They move with the text when * text is inserted/deleted. * * Text properties have a user specified ID number, which can be unique. * Text properties have a type, which can be used to specify highlighting. * * TODO: * - Add an arrray for global_proptypes, to quickly lookup a proptype by ID * - Add an arrray for b_proptypes, to quickly lookup a proptype by ID * - adjust property column when text is inserted/deleted * - support properties that continue over a line break * - add mechanism to keep track of changed lines. */ #include "vim.h" #if defined(FEAT_TEXT_PROP) || defined(PROTO) /* * In a hashtable item "hi_key" points to "pt_name" in a proptype_T. * This avoids adding a pointer to the hashtable item. * PT2HIKEY() converts a proptype pointer to a hashitem key pointer. * HIKEY2PT() converts a hashitem key pointer to a proptype pointer. * HI2PT() converts a hashitem pointer to a proptype pointer. */ #define PT2HIKEY(p) ((p)->pt_name) #define HIKEY2PT(p) ((proptype_T *)((p) - offsetof(proptype_T, pt_name))) #define HI2PT(hi) HIKEY2PT((hi)->hi_key) // The global text property types. static hashtab_T *global_proptypes = NULL; // The last used text property type ID. static int proptype_id = 0; static char_u e_type_not_exist[] = N_("E971: Property type %s does not exist"); static char_u e_invalid_col[] = N_("E964: Invalid column number: %ld"); /* * Find a property type by name, return the hashitem. * Returns NULL if the item can't be found. */ static hashitem_T * find_prop_hi(char_u *name, buf_T *buf) { hashtab_T *ht; hashitem_T *hi; if (*name == NUL) return NULL; if (buf == NULL) ht = global_proptypes; else ht = buf->b_proptypes; if (ht == NULL) return NULL; hi = hash_find(ht, name); if (HASHITEM_EMPTY(hi)) return NULL; return hi; } /* * Like find_prop_hi() but return the property type. */ static proptype_T * find_prop(char_u *name, buf_T *buf) { hashitem_T *hi = find_prop_hi(name, buf); if (hi == NULL) return NULL; return HI2PT(hi); } /* * Lookup a property type by name. First in "buf" and when not found in the * global types. * When not found gives an error message and returns NULL. */ static proptype_T * lookup_prop_type(char_u *name, buf_T *buf) { proptype_T *type = find_prop(name, buf); if (type == NULL) type = find_prop(name, NULL); if (type == NULL) EMSG2(_(e_type_not_exist), name); return type; } /* * Get an optional "bufnr" item from the dict in "arg". * When the argument is not used or "bufnr" is not present then "buf" is * unchanged. * If "bufnr" is valid or not present return OK. * When "arg" is not a dict or "bufnr" is invalide return FAIL. */ static int get_bufnr_from_arg(typval_T *arg, buf_T **buf) { dictitem_T *di; if (arg->v_type != VAR_DICT) { EMSG(_(e_dictreq)); return FAIL; } if (arg->vval.v_dict == NULL) return OK; // NULL dict is like an empty dict di = dict_find(arg->vval.v_dict, (char_u *)"bufnr", -1); if (di != NULL) { *buf = get_buf_tv(&di->di_tv, FALSE); if (*buf == NULL) return FAIL; } return OK; } /* * prop_add({lnum}, {col}, {props}) */ void f_prop_add(typval_T *argvars, typval_T *rettv UNUSED) { linenr_T lnum; colnr_T col; dict_T *dict; colnr_T length = 1; char_u *type_name; proptype_T *type; buf_T *buf = curbuf; int id = 0; char_u *newtext; int proplen; size_t textlen; char_u *props; char_u *newprops; static textprop_T tmp_prop; // static to get it aligned. int i; lnum = get_tv_number(&argvars[0]); col = get_tv_number(&argvars[1]); if (col < 1) { EMSGN(_(e_invalid_col), (long)col); return; } if (argvars[2].v_type != VAR_DICT) { EMSG(_(e_dictreq)); return; } dict = argvars[2].vval.v_dict; if (dict == NULL || dict_find(dict, (char_u *)"type", -1) == NULL) { EMSG(_("E965: missing property type name")); return; } type_name = get_dict_string(dict, (char_u *)"type", FALSE); if (dict_find(dict, (char_u *)"end_lnum", -1) != NULL) { // TODO: handle end_lnum EMSG("Sorry, end_lnum not supported yet"); return; } if (dict_find(dict, (char_u *)"length", -1) != NULL) length = get_dict_number(dict, (char_u *)"length"); else if (dict_find(dict, (char_u *)"end_col", -1) != NULL) { length = get_dict_number(dict, (char_u *)"end_col") - col; if (length <= 0) { EMSG2(_(e_invargval), "end_col"); return; } } if (dict_find(dict, (char_u *)"id", -1) != NULL) id = get_dict_number(dict, (char_u *)"id"); if (get_bufnr_from_arg(&argvars[2], &buf) == FAIL) return; type = lookup_prop_type(type_name, buf); if (type == NULL) return; if (lnum < 1 || lnum > buf->b_ml.ml_line_count) { EMSGN(_("E966: Invalid line number: %ld"), (long)lnum); return; } // Fetch the line to get the ml_line_len field updated. proplen = get_text_props(buf, lnum, &props, TRUE); if (col >= (colnr_T)STRLEN(buf->b_ml.ml_line_ptr)) { EMSGN(_(e_invalid_col), (long)col); return; } // Allocate the new line with space for the new proprety. newtext = alloc(buf->b_ml.ml_line_len + sizeof(textprop_T)); if (newtext == NULL) return; // Copy the text, including terminating NUL. textlen = buf->b_ml.ml_line_len - proplen * sizeof(textprop_T); mch_memmove(newtext, buf->b_ml.ml_line_ptr, textlen); // Find the index where to insert the new property. // Since the text properties are not aligned properly when stored with the // text, we need to copy them as bytes before using it as a struct. for (i = 0; i < proplen; ++i) { mch_memmove(&tmp_prop, props + i * sizeof(proptype_T), sizeof(proptype_T)); if (tmp_prop.tp_col >= col) break; } newprops = newtext + textlen; if (i > 0) mch_memmove(newprops, props, sizeof(textprop_T) * i); tmp_prop.tp_col = col; tmp_prop.tp_len = length; tmp_prop.tp_id = id; tmp_prop.tp_type = type->pt_id; tmp_prop.tp_flags = 0; mch_memmove(newprops + i * sizeof(textprop_T), &tmp_prop, sizeof(textprop_T)); if (i < proplen) mch_memmove(newprops + (i + 1) * sizeof(textprop_T), props + i * sizeof(textprop_T), sizeof(textprop_T) * (proplen - i)); if (buf->b_ml.ml_flags & ML_LINE_DIRTY) vim_free(buf->b_ml.ml_line_ptr); buf->b_ml.ml_line_ptr = newtext; buf->b_ml.ml_line_len += sizeof(textprop_T); buf->b_ml.ml_flags |= ML_LINE_DIRTY; redraw_buf_later(buf, NOT_VALID); } /* * Return TRUE if any text properties are defined globally or for buffer * 'buf". */ int has_any_text_properties(buf_T *buf) { return buf->b_proptypes != NULL || global_proptypes != NULL; } /* * Fetch the text properties for line "lnum" in buffer 'buf". * Returns the number of text properties and, when non-zero, a pointer to the * first one in "props" (note that it is not aligned, therefore the char_u * pointer). */ int get_text_props(buf_T *buf, linenr_T lnum, char_u **props, int will_change) { char_u *text; size_t textlen; size_t proplen; // Be quick when no text property types are defined. if (!has_any_text_properties(buf)) return 0; // Fetch the line to get the ml_line_len field updated. text = ml_get_buf(buf, lnum, will_change); textlen = STRLEN(text) + 1; proplen = buf->b_ml.ml_line_len - textlen; if (proplen % sizeof(textprop_T) != 0) { IEMSG(_("E967: text property info corrupted")); return 0; } if (proplen > 0) *props = text + textlen; return proplen / sizeof(textprop_T); } static proptype_T * find_type_by_id(hashtab_T *ht, int id) { long todo; hashitem_T *hi; if (ht == NULL) return NULL; // TODO: Make this faster by keeping a list of types sorted on ID and use // a binary search. todo = (long)ht->ht_used; for (hi = ht->ht_array; todo > 0; ++hi) { if (!HASHITEM_EMPTY(hi)) { proptype_T *prop = HI2PT(hi); if (prop->pt_id == id) return prop; --todo; } } return NULL; } /* * Find a property type by ID in "buf" or globally. * Returns NULL if not found. */ proptype_T * text_prop_type_by_id(buf_T *buf, int id) { proptype_T *type; type = find_type_by_id(buf->b_proptypes, id); if (type == NULL) type = find_type_by_id(global_proptypes, id); return type; } /* * prop_clear({lnum} [, {lnum_end} [, {bufnr}]]) */ void f_prop_clear(typval_T *argvars, typval_T *rettv UNUSED) { linenr_T start = get_tv_number(&argvars[0]); linenr_T end = start; linenr_T lnum; buf_T *buf = curbuf; if (argvars[1].v_type != VAR_UNKNOWN) { end = get_tv_number(&argvars[1]); if (argvars[2].v_type != VAR_UNKNOWN) { if (get_bufnr_from_arg(&argvars[2], &buf) == FAIL) return; } } if (start < 1 || end < 1) { EMSG(_(e_invrange)); return; } for (lnum = start; lnum <= end; ++lnum) { char_u *text; size_t len; if (lnum > buf->b_ml.ml_line_count) break; text = ml_get_buf(buf, lnum, FALSE); len = STRLEN(text) + 1; if ((size_t)buf->b_ml.ml_line_len > len) { if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY)) { char_u *newtext = vim_strsave(text); // need to allocate the line now if (newtext == NULL) return; buf->b_ml.ml_line_ptr = newtext; buf->b_ml.ml_flags |= ML_LINE_DIRTY; } buf->b_ml.ml_line_len = len; } } redraw_buf_later(buf, NOT_VALID); } /* * prop_list({lnum} [, {bufnr}]) */ void f_prop_list(typval_T *argvars, typval_T *rettv) { linenr_T lnum = get_tv_number(&argvars[0]); buf_T *buf = curbuf; if (argvars[1].v_type != VAR_UNKNOWN) { if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL) return; } if (lnum < 1 || lnum > buf->b_ml.ml_line_count) { EMSG(_(e_invrange)); return; } if (rettv_list_alloc(rettv) == OK) { char_u *text = ml_get_buf(buf, lnum, FALSE); size_t textlen = STRLEN(text) + 1; int count = (buf->b_ml.ml_line_len - textlen) / sizeof(textprop_T); int i; textprop_T prop; proptype_T *pt; for (i = 0; i < count; ++i) { dict_T *d = dict_alloc(); if (d == NULL) break; mch_memmove(&prop, text + textlen + i * sizeof(textprop_T), sizeof(textprop_T)); dict_add_number(d, "col", prop.tp_col); dict_add_number(d, "length", prop.tp_len); dict_add_number(d, "id", prop.tp_id); dict_add_number(d, "start", !(prop.tp_flags & TP_FLAG_CONT_PREV)); dict_add_number(d, "end", !(prop.tp_flags & TP_FLAG_CONT_NEXT)); pt = text_prop_type_by_id(buf, prop.tp_type); if (pt != NULL) dict_add_string(d, "type", pt->pt_name); list_append_dict(rettv->vval.v_list, d); } } } /* * prop_remove({props} [, {lnum} [, {lnum_end}]]) */ void f_prop_remove(typval_T *argvars, typval_T *rettv) { linenr_T start = 1; linenr_T end = 0; linenr_T lnum; dict_T *dict; buf_T *buf = curbuf; dictitem_T *di; int do_all = FALSE; int id = -1; int type_id = -1; rettv->vval.v_number = 0; if (argvars[0].v_type != VAR_DICT || argvars[0].vval.v_dict == NULL) { EMSG(_(e_invarg)); return; } if (argvars[1].v_type != VAR_UNKNOWN) { start = get_tv_number(&argvars[1]); end = start; if (argvars[2].v_type != VAR_UNKNOWN) end = get_tv_number(&argvars[2]); if (start < 1 || end < 1) { EMSG(_(e_invrange)); return; } } dict = argvars[0].vval.v_dict; di = dict_find(dict, (char_u *)"bufnr", -1); if (di != NULL) { buf = get_buf_tv(&di->di_tv, FALSE); if (buf == NULL) return; } di = dict_find(dict, (char_u*)"all", -1); if (di != NULL) do_all = get_dict_number(dict, (char_u *)"all"); if (dict_find(dict, (char_u *)"id", -1) != NULL) id = get_dict_number(dict, (char_u *)"id"); if (dict_find(dict, (char_u *)"type", -1)) { char_u *name = get_dict_string(dict, (char_u *)"type", FALSE); proptype_T *type = lookup_prop_type(name, buf); if (type == NULL) return; type_id = type->pt_id; } if (id == -1 && type_id == -1) { EMSG(_("E968: Need at least one of 'id' or 'type'")); return; } if (end == 0) end = buf->b_ml.ml_line_count; for (lnum = start; lnum <= end; ++lnum) { char_u *text; size_t len; if (lnum > buf->b_ml.ml_line_count) break; text = ml_get_buf(buf, lnum, FALSE); len = STRLEN(text) + 1; if ((size_t)buf->b_ml.ml_line_len > len) { static textprop_T textprop; // static because of alignment unsigned idx; for (idx = 0; idx < (buf->b_ml.ml_line_len - len) / sizeof(textprop_T); ++idx) { char_u *cur_prop = buf->b_ml.ml_line_ptr + len + idx * sizeof(textprop_T); size_t taillen; mch_memmove(&textprop, cur_prop, sizeof(textprop_T)); if (textprop.tp_id == id || textprop.tp_type == type_id) { if (!(buf->b_ml.ml_flags & ML_LINE_DIRTY)) { char_u *newptr = alloc(buf->b_ml.ml_line_len); // need to allocate the line to be able to change it if (newptr == NULL) return; mch_memmove(newptr, buf->b_ml.ml_line_ptr, buf->b_ml.ml_line_len); buf->b_ml.ml_line_ptr = newptr; curbuf->b_ml.ml_flags |= ML_LINE_DIRTY; } taillen = buf->b_ml.ml_line_len - len - (idx + 1) * sizeof(textprop_T); if (taillen > 0) mch_memmove(cur_prop, cur_prop + sizeof(textprop_T), taillen); buf->b_ml.ml_line_len -= sizeof(textprop_T); --idx; ++rettv->vval.v_number; if (!do_all) break; } } } } redraw_buf_later(buf, NOT_VALID); } /* * Common for f_prop_type_add() and f_prop_type_change(). */ void prop_type_set(typval_T *argvars, int add) { char_u *name; buf_T *buf = NULL; dict_T *dict; dictitem_T *di; proptype_T *prop; name = get_tv_string(&argvars[0]); if (*name == NUL) { EMSG(_(e_invarg)); return; } if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL) return; dict = argvars[1].vval.v_dict; prop = find_prop(name, buf); if (add) { hashtab_T **htp; if (prop != NULL) { EMSG2(_("E969: Property type %s already defined"), name); return; } prop = (proptype_T *)alloc_clear(sizeof(proptype_T) + STRLEN(name)); if (prop == NULL) return; STRCPY(prop->pt_name, name); prop->pt_id = ++proptype_id; htp = buf == NULL ? &global_proptypes : &buf->b_proptypes; if (*htp == NULL) { *htp = (hashtab_T *)alloc(sizeof(hashtab_T)); if (*htp == NULL) return; hash_init(*htp); } hash_add(buf == NULL ? global_proptypes : buf->b_proptypes, PT2HIKEY(prop)); } else { if (prop == NULL) { EMSG2(_(e_type_not_exist), name); return; } } if (dict != NULL) { di = dict_find(dict, (char_u *)"highlight", -1); if (di != NULL) { char_u *highlight; int hl_id = 0; highlight = get_dict_string(dict, (char_u *)"highlight", TRUE); if (highlight != NULL && *highlight != NUL) hl_id = syn_name2id(highlight); if (hl_id <= 0) { EMSG2(_("E970: Unknown highlight group name: '%s'"), highlight == NULL ? (char_u *)"" : highlight); return; } prop->pt_hl_id = hl_id; } di = dict_find(dict, (char_u *)"priority", -1); if (di != NULL) prop->pt_priority = get_tv_number(&di->di_tv); di = dict_find(dict, (char_u *)"start_incl", -1); if (di != NULL) { if (get_tv_number(&di->di_tv)) prop->pt_flags |= PT_FLAG_INS_START_INCL; else prop->pt_flags &= ~PT_FLAG_INS_START_INCL; } di = dict_find(dict, (char_u *)"end_incl", -1); if (di != NULL) { if (get_tv_number(&di->di_tv)) prop->pt_flags |= PT_FLAG_INS_END_INCL; else prop->pt_flags &= ~PT_FLAG_INS_END_INCL; } } } /* * prop_type_add({name}, {props}) */ void f_prop_type_add(typval_T *argvars, typval_T *rettv UNUSED) { prop_type_set(argvars, TRUE); } /* * prop_type_change({name}, {props}) */ void f_prop_type_change(typval_T *argvars, typval_T *rettv UNUSED) { prop_type_set(argvars, FALSE); } /* * prop_type_delete({name} [, {bufnr}]) */ void f_prop_type_delete(typval_T *argvars, typval_T *rettv UNUSED) { char_u *name; buf_T *buf = NULL; hashitem_T *hi; name = get_tv_string(&argvars[0]); if (*name == NUL) { EMSG(_(e_invarg)); return; } if (argvars[1].v_type != VAR_UNKNOWN) { if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL) return; } hi = find_prop_hi(name, buf); if (hi != NULL) { hashtab_T *ht; if (buf == NULL) ht = global_proptypes; else ht = buf->b_proptypes; hash_remove(ht, hi); } } /* * prop_type_get({name} [, {bufnr}]) */ void f_prop_type_get(typval_T *argvars, typval_T *rettv UNUSED) { char_u *name = get_tv_string(&argvars[0]); if (*name == NUL) { EMSG(_(e_invarg)); return; } if (rettv_dict_alloc(rettv) == OK) { proptype_T *prop = NULL; buf_T *buf = NULL; if (argvars[1].v_type != VAR_UNKNOWN) { if (get_bufnr_from_arg(&argvars[1], &buf) == FAIL) return; } prop = find_prop(name, buf); if (prop != NULL) { dict_T *d = rettv->vval.v_dict; if (prop->pt_hl_id > 0) dict_add_string(d, "highlight", syn_id2name(prop->pt_hl_id)); dict_add_number(d, "priority", prop->pt_priority); dict_add_number(d, "start_incl", (prop->pt_flags & PT_FLAG_INS_START_INCL) ? 1 : 0); dict_add_number(d, "end_incl", (prop->pt_flags & PT_FLAG_INS_END_INCL) ? 1 : 0); if (buf != NULL) dict_add_number(d, "bufnr", buf->b_fnum); } } } static void list_types(hashtab_T *ht, list_T *l) { long todo; hashitem_T *hi; todo = (long)ht->ht_used; for (hi = ht->ht_array; todo > 0; ++hi) { if (!HASHITEM_EMPTY(hi)) { proptype_T *prop = HI2PT(hi); list_append_string(l, prop->pt_name, -1); --todo; } } } /* * prop_type_list([{bufnr}]) */ void f_prop_type_list(typval_T *argvars, typval_T *rettv UNUSED) { buf_T *buf = NULL; if (rettv_list_alloc(rettv) == OK) { if (argvars[0].v_type != VAR_UNKNOWN) { if (get_bufnr_from_arg(&argvars[0], &buf) == FAIL) return; } if (buf == NULL) { if (global_proptypes != NULL) list_types(global_proptypes, rettv->vval.v_list); } else if (buf->b_proptypes != NULL) list_types(buf->b_proptypes, rettv->vval.v_list); } } /* * Free all property types in "ht". */ static void clear_ht_prop_types(hashtab_T *ht) { long todo; hashitem_T *hi; if (ht == NULL) return; todo = (long)ht->ht_used; for (hi = ht->ht_array; todo > 0; ++hi) { if (!HASHITEM_EMPTY(hi)) { proptype_T *prop = HI2PT(hi); vim_free(prop); --todo; } } hash_clear(ht); vim_free(ht); } #if defined(EXITFREE) || defined(PROTO) /* * Free all property types for "buf". */ void clear_global_prop_types(void) { clear_ht_prop_types(global_proptypes); global_proptypes = NULL; } #endif /* * Free all property types for "buf". */ void clear_buf_prop_types(buf_T *buf) { clear_ht_prop_types(buf->b_proptypes); buf->b_proptypes = NULL; } #endif // FEAT_TEXT_PROP