diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index bfc1c235eae0cd..fd1d0f8ea64c85 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -804,6 +804,9 @@ CTRL-X CTRL-K Search the files given with the 'dictionary' option CTRL-P Search backwards for next matching keyword. This keyword replaces the previous matching keyword. + +Completing words in 'thesaurus' *compl-thesaurus* + *i_CTRL-X_CTRL-T* CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses the 'thesaurus' option instead of 'dictionary'. If a @@ -812,16 +815,6 @@ CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses matches, even though they don't complete the word. Thus a word can be completely replaced. - For an example, imagine the 'thesaurus' file has a - line like this: > - angry furious mad enraged -< Placing the cursor after the letters "ang" and typing - CTRL-X CTRL-T would complete the word "angry"; - subsequent presses would change the word to "furious", - "mad" etc. - Other uses include translation between two languages, - or grouping API functions by keyword. - CTRL-T or CTRL-N Search forward for next matching keyword. This keyword replaces the previous matching keyword. @@ -829,6 +822,59 @@ CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses CTRL-P Search backwards for next matching keyword. This keyword replaces the previous matching keyword. +In the file used by the 'thesaurus' option each line in the file should +contain words with similar meaning, separated by non-keyword characters (white +space is preferred). Maximum line length is 510 bytes. + +For an example, imagine the 'thesaurus' file has a line like this: > + angry furious mad enraged + + + func Thesaur(findstart, base) + if a:findstart + let line = getline('.') + let start = col('.') - 1 + while start > 0 && line[start - 1] =~ '\a' + let start -= 1 + endwhile + return start + else + let res = [] + let h = '' + for l in split(system('aiksaurus '.shellescape(a:base)), '\n') + if l[:3] == '=== ' + let h = substitute(l[4:], ' =*$', '', '') + elseif l[0] =~ '\a' + call extend(res, map(split(l, ', '), {_, val -> {'word': val, 'menu': '('.h.')'}})) + endif + endfor + return res + endif + endfunc + + set thesaurusfunc=Thesaur + Completing keywords in the current and included files *compl-keyword* @@ -1032,7 +1078,7 @@ CTRL-X CTRL-Z Stop completion without changing the text. FUNCTIONS FOR FINDING COMPLETIONS *complete-functions* -This applies to 'completefunc' and 'omnifunc'. +This applies to 'completefunc', 'thesaurusfunc' and 'omnifunc'. The function is called in two different ways: - First the function is called to find the start of the text to be completed. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 184c6de503ffaa..399a59251ad9e7 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -6448,19 +6448,28 @@ A jump table for the options with a short description can be found at |Q_op|. 'thesaurus' 'tsr' string (default "") global or local to buffer |global-local| List of file names, separated by commas, that are used to lookup words - for thesaurus completion commands |i_CTRL-X_CTRL-T|. + for thesaurus completion commands |i_CTRL-X_CTRL-T|. See + |compl-thesaurus|. - Each line in the file should contain words with similar meaning, - separated by non-keyword characters (white space is preferred). - Maximum line length is 510 bytes. + This option is not used if 'thesaurusfunc' is set, either for the + buffer or globally. To include a comma in a file name precede it with a backslash. Spaces after a comma are ignored, otherwise spaces are included in the file - name. See |option-backslash| about using backslashes. - The use of |:set+=| and |:set-=| is preferred when adding or removing - directories from the list. This avoids problems when a future version - uses another default. - Backticks cannot be used in this option for security reasons. + name. See |option-backslash| about using backslashes. The use of + |:set+=| and |:set-=| is preferred when adding or removing directories + from the list. This avoids problems when a future version uses + another default. Backticks cannot be used in this option for security + reasons. + + *'thesaurusfunc'* *'tsrfu'* +'thesaurusfunc' 'tsrfu' string (default: empty) + global or local to buffer |global-local| + This option specifies a function to be used for thesaurus completion + with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|. + + This option cannot be set from a |modeline| or in the |sandbox|, for + security reasons. *'tildeop'* *'top'* *'notildeop'* *'notop'* 'tildeop' 'top' boolean (default off) diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt index 77e69a3eea89f3..8cabf050536267 100644 --- a/runtime/doc/quickref.txt +++ b/runtime/doc/quickref.txt @@ -895,6 +895,7 @@ Short explanation of each option: *option-list* 'terse' shorten some messages 'textwidth' 'tw' maximum width of text that is being inserted 'thesaurus' 'tsr' list of thesaurus files for keyword completion +'thesaurusfunc' 'tsrfu' function to be used for thesaurus completion 'tildeop' 'top' tilde command "~" behaves like an operator 'timeout' 'to' time out on mappings and key codes 'timeoutlen' 'tm' time out time in milliseconds diff --git a/src/nvim/buffer.c b/src/nvim/buffer.c index 41bf38d76bddd2..e9d89c2f91b289 100644 --- a/src/nvim/buffer.c +++ b/src/nvim/buffer.c @@ -1925,6 +1925,7 @@ void free_buf_options(buf_T *buf, int free_p_ff) clear_string_option(&buf->b_p_cpt); clear_string_option(&buf->b_p_cfu); clear_string_option(&buf->b_p_ofu); + clear_string_option(&buf->b_p_tsrfu); clear_string_option(&buf->b_p_gp); clear_string_option(&buf->b_p_mp); clear_string_option(&buf->b_p_efm); diff --git a/src/nvim/buffer_defs.h b/src/nvim/buffer_defs.h index 074dde86f1e21d..bd9c5efa441a61 100644 --- a/src/nvim/buffer_defs.h +++ b/src/nvim/buffer_defs.h @@ -766,6 +766,7 @@ struct file_buffer { unsigned b_tc_flags; ///< flags for 'tagcase' char_u *b_p_dict; ///< 'dictionary' local value char_u *b_p_tsr; ///< 'thesaurus' local value + char_u *b_p_tsrfu; ///< 'thesaurusfunc' local value long b_p_ul; ///< 'undolevels' local value int b_p_udf; ///< 'undofile' char_u *b_p_lw; ///< 'lispwords' local value diff --git a/src/nvim/edit.c b/src/nvim/edit.c index 593ba4e843ee0f..ca903fdcf79fb8 100644 --- a/src/nvim/edit.c +++ b/src/nvim/edit.c @@ -2071,7 +2071,8 @@ static bool check_compl_option(bool dict_opt) { if (dict_opt ? (*curbuf->b_p_dict == NUL && *p_dict == NUL && !curwin->w_p_spell) - : (*curbuf->b_p_tsr == NUL && *p_tsr == NUL)) { + : (*curbuf->b_p_tsr == NUL && *p_tsr == NUL + && *curbuf->b_p_tsrfu == NUL && *p_tsrfu == NUL)) { ctrl_x_mode = CTRL_X_NORMAL; edit_submode = NULL; msg_attr((dict_opt @@ -3922,6 +3923,20 @@ static buf_T *ins_compl_next_buf(buf_T *buf, int flag) } +/// Get the user-defined completion function name for completion 'type' +static char_u *get_complete_funcname(int type) { + switch (type) { + case CTRL_X_FUNCTION: + return curbuf->b_p_cfu; + case CTRL_X_OMNI: + return curbuf->b_p_ofu; + case CTRL_X_THESAURUS: + return *curbuf->b_p_tsrfu == NUL ? p_tsrfu : curbuf->b_p_tsrfu; + default: + return (char_u *)""; + } +} + /// Execute user defined complete function 'completefunc' or 'omnifunc', and /// get matches in "matches". /// @@ -3938,7 +3953,7 @@ static void expand_by_function(int type, char_u *base) const int save_State = State; assert(curbuf != NULL); - funcname = (type == CTRL_X_FUNCTION) ? curbuf->b_p_cfu : curbuf->b_p_ofu; + funcname = get_complete_funcname(type); if (*funcname == NUL) { return; } @@ -4097,6 +4112,13 @@ int ins_compl_add_tv(typval_T *const tv, const Direction dir, bool fast) (char_u **)cptext, true, &user_data, dir, flags, dup); } +/// Returns true when using a user-defined function for thesaurus completion. +static bool thesaurus_func_complete(int type) +{ + return type == CTRL_X_THESAURUS + && (*curbuf->b_p_tsrfu != NUL || *p_tsrfu != NUL); +} + // Get the next expansion(s), using "compl_pattern". // The search starts at position "ini" in curbuf and in the direction // compl_direction. @@ -4270,17 +4292,17 @@ static int ins_compl_get_exp(pos_T *ini) case CTRL_X_DICTIONARY: case CTRL_X_THESAURUS: - ins_compl_dictionaries(dict != NULL ? dict - : (type == CTRL_X_THESAURUS - ? (*curbuf->b_p_tsr == NUL - ? p_tsr - : curbuf->b_p_tsr) - : (*curbuf->b_p_dict == NUL - ? p_dict - : curbuf->b_p_dict)), - compl_pattern, - dict != NULL ? dict_f - : 0, type == CTRL_X_THESAURUS); + if (thesaurus_func_complete(type)) { + expand_by_function(type, compl_pattern); + } else { + ins_compl_dictionaries(dict != NULL ? dict + : (type == CTRL_X_THESAURUS + ? (*curbuf->b_p_tsr == NUL ? p_tsr : curbuf->b_p_tsr) + : (*curbuf->b_p_dict == + NUL ? p_dict : curbuf->b_p_dict)), + compl_pattern, + dict != NULL ? dict_f : 0, type == CTRL_X_THESAURUS); + } dict = NULL; break; @@ -5093,7 +5115,9 @@ static int ins_complete(int c, bool enable_pum) } // Work out completion pattern and original text -- webb - if (ctrl_x_mode == CTRL_X_NORMAL || (ctrl_x_mode & CTRL_X_WANT_IDENT)) { + if (ctrl_x_mode == CTRL_X_NORMAL + || (ctrl_x_mode & CTRL_X_WANT_IDENT + && !thesaurus_func_complete(ctrl_x_mode))) { if ((compl_cont_status & CONT_SOL) || ctrl_x_mode == CTRL_X_PATH_DEFINES) { if (!(compl_cont_status & CONT_ADDING)) { @@ -5203,22 +5227,18 @@ static int ins_complete(int c, bool enable_pum) compl_col = (int)(compl_xp.xp_pattern - compl_pattern); } compl_length = curs_col - compl_col; - } else if (ctrl_x_mode == CTRL_X_FUNCTION || ctrl_x_mode == - CTRL_X_OMNI) { - /* - * Call user defined function 'completefunc' with "a:findstart" - * set to 1 to obtain the length of text to use for completion. - */ + } else if (ctrl_x_mode == CTRL_X_FUNCTION || ctrl_x_mode == CTRL_X_OMNI + || thesaurus_func_complete(ctrl_x_mode)) { + // Call user defined function 'completefunc' with "a:findstart" + // set to 1 to obtain the length of text to use for completion. char_u *funcname; pos_T pos; win_T *curwin_save; buf_T *curbuf_save; const int save_State = State; - /* Call 'completefunc' or 'omnifunc' and get pattern length as a - * string */ - funcname = ctrl_x_mode == CTRL_X_FUNCTION - ? curbuf->b_p_cfu : curbuf->b_p_ofu; + // Call 'completefunc' or 'omnifunc' and get pattern length as a string + funcname = get_complete_funcname(ctrl_x_mode); if (*funcname == NUL) { semsg(_(e_notset), ctrl_x_mode == CTRL_X_FUNCTION ? "completefunc" : "omnifunc"); diff --git a/src/nvim/option.c b/src/nvim/option.c index 36a87d5a4996df..b7df8569490a99 100644 --- a/src/nvim/option.c +++ b/src/nvim/option.c @@ -2034,6 +2034,7 @@ void check_buf_options(buf_T *buf) check_string_option(&buf->b_p_tc); check_string_option(&buf->b_p_dict); check_string_option(&buf->b_p_tsr); + check_string_option(&buf->b_p_tsrfu); check_string_option(&buf->b_p_lw); check_string_option(&buf->b_p_bkc); check_string_option(&buf->b_p_menc); @@ -5536,6 +5537,9 @@ void unset_global_local_option(char *name, void *from) case PV_TSR: clear_string_option(&buf->b_p_tsr); break; + case PV_TSRFU: + clear_string_option(&buf->b_p_tsrfu); + break; case PV_FP: clear_string_option(&buf->b_p_fp); break; @@ -5619,6 +5623,8 @@ static char_u *get_varp_scope(vimoption_T *p, int opt_flags) return (char_u *)&(curbuf->b_p_dict); case PV_TSR: return (char_u *)&(curbuf->b_p_tsr); + case PV_TSRFU: + return (char_u *)&(curbuf->b_p_tsrfu); case PV_TFU: return (char_u *)&(curbuf->b_p_tfu); case PV_SBR: @@ -5695,6 +5701,9 @@ static char_u *get_varp(vimoption_T *p) case PV_TSR: return *curbuf->b_p_tsr != NUL ? (char_u *)&(curbuf->b_p_tsr) : p->var; + case PV_TSRFU: + return *curbuf->b_p_tsrfu != NUL + ? (char_u *)&(curbuf->b_p_tsrfu) : p->var; case PV_FP: return *curbuf->b_p_fp != NUL ? (char_u *)&(curbuf->b_p_fp) : p->var; @@ -6253,6 +6262,7 @@ void buf_copy_options(buf_T *buf, int flags) buf->b_p_inex = vim_strsave(p_inex); buf->b_p_dict = empty_option; buf->b_p_tsr = empty_option; + buf->b_p_tsrfu = empty_option; buf->b_p_qe = vim_strsave(p_qe); buf->b_p_udf = p_udf; buf->b_p_lw = empty_option; diff --git a/src/nvim/option_defs.h b/src/nvim/option_defs.h index 6edc15be57efd3..19cb33a354955e 100644 --- a/src/nvim/option_defs.h +++ b/src/nvim/option_defs.h @@ -686,6 +686,7 @@ EXTERN long p_titlelen; ///< 'titlelen' EXTERN char_u *p_titleold; ///< 'titleold' EXTERN char_u *p_titlestring; ///< 'titlestring' EXTERN char_u *p_tsr; ///< 'thesaurus' +EXTERN char_u *p_tsrfu; ///< 'thesaurusfunc' EXTERN int p_tgc; ///< 'termguicolors' EXTERN int p_ttimeout; ///< 'ttimeout' EXTERN long p_ttm; ///< 'ttimeoutlen' @@ -826,6 +827,7 @@ enum { BV_SW, BV_SWF, BV_TFU, + BV_TSRFU, BV_TAGS, BV_TC, BV_TS, diff --git a/src/nvim/options.lua b/src/nvim/options.lua index 8b9cdefd575966..71208dfc682851 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -2535,6 +2535,15 @@ return { varname='p_tsr', defaults={if_true=""} }, + { + full_name='thesaurusfunc', abbreviation='tsrfu', + short_desc=N_("function used for thesaurus completion"), + type='string', scope={'global', 'buffer'}, + secure=true, + alloced=true, + varname='p_tsrfu', + defaults={if_true=""} + }, { full_name='tildeop', abbreviation='top', short_desc=N_("tilde command \"~\" behaves like an operator"), diff --git a/src/nvim/testdir/test_edit.vim b/src/nvim/testdir/test_edit.vim index 2b389c015f2141..23ad8dbfc5bd38 100644 --- a/src/nvim/testdir/test_edit.vim +++ b/src/nvim/testdir/test_edit.vim @@ -870,6 +870,56 @@ func Test_edit_CTRL_T() bw! endfunc +" Test 'thesaurusfunc' +func MyThesaurus(findstart, base) + let mythesaurus = [ + \ #{word: "happy", + \ synonyms: "cheerful,blissful,flying high,looking good,peppy"}, + \ #{word: "kind", + \ synonyms: "amiable,bleeding-heart,heart in right place"}] + if a:findstart + " locate the start of the word + let line = getline('.') + let start = col('.') - 1 + while start > 0 && line[start - 1] =~ '\a' + let start -= 1 + endwhile + return start + else + " find strings matching with "a:base" + let res = [] + for w in mythesaurus + if w.word =~ '^' . a:base + call add(res, w.word) + call extend(res, split(w.synonyms, ",")) + endif + endfor + return res + endif +endfunc + +func Test_thesaurus_func() + new + set thesaurus=notused + set thesaurusfunc=NotUsed + setlocal thesaurusfunc=MyThesaurus + call setline(1, "an ki") + call cursor(1, 1) + call feedkeys("A\\\\\", 'tnix') + call assert_equal(['an amiable', ''], getline(1, '$')) + + setlocal thesaurusfunc=NonExistingFunc + call assert_fails("normal $a\\", 'E117:') + + setlocal thesaurusfunc= + set thesaurusfunc=NonExistingFunc + call assert_fails("normal $a\\", 'E117:') + %bw! + + set thesaurusfunc= + set thesaurus= +endfunc + func Test_edit_CTRL_U() " Test 'completefunc' new diff --git a/src/nvim/testdir/test_options.vim b/src/nvim/testdir/test_options.vim index 72c151142d81cd..41c689849b815b 100644 --- a/src/nvim/testdir/test_options.vim +++ b/src/nvim/testdir/test_options.vim @@ -209,7 +209,7 @@ func Test_set_completion() " Expand abbreviation of options. call feedkeys(":set ts\\\"\", 'tx') - call assert_equal('"set tabstop thesaurus', @:) + call assert_equal('"set tabstop thesaurus thesaurusfunc', @:) " Expand current value call feedkeys(":set fileencodings=\\\"\", 'tx')