IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17440 from zeertzjq/vim-8.2.3184

Browse Source 
vim-patch:8.2.{3184,3226,3325}: digraph functions
This commit is contained in:
zeertzjq 2022-04-12 21:54:01 +08:00 committed by GitHub
commit 4bef2f02e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 421 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
runtime/doc/builtin.txt
View File

@ -119,6 +119,10 @@ dictwatcherdel({dict}, {pattern}, {callback})
did_filetype() Number |TRUE| if FileType autocommand event used
diff_filler({lnum}) Number diff filler lines about {lnum}
diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
digraph_get({chars}) String get the digraph of {chars}
digraph_getlist([{listall}]) List get all |digraph|s
digraph_set({chars}, {digraph}) Boolean register |digraph|
digraph_setlist({digraphlist}) Boolean register multiple |digraph|s
empty({expr}) Number |TRUE| if {expr} is empty
environ() Dict return environment variables
escape({string}, {chars}) String escape {chars} in {string} with '\'
@ -1636,6 +1640,85 @@ diff_hlID({lnum}, {col}) *diff_hlID()*
Can also be used as a |method|: >
GetLnum()->diff_hlID(col)
<
digraph_get({chars}) *digraph_get()* *E1214*
Return the digraph of {chars}. This should be a string with
exactly two characters. If {chars} are not just two
characters, or the digraph of {chars} does not exist, an error
is given and an empty string is returned.
Also see |digraph_getlist()|.
Examples: >
" Get a built-in digraph
:echo digraph_get('00') " Returns '∞'
" Get a user-defined digraph
:call digraph_set('aa', 'あ')
:echo digraph_get('aa') " Returns 'あ'
<
Can also be used as a |method|: >
GetChars()->digraph_get()
<
digraph_getlist([{listall}]) *digraph_getlist()*
Return a list of digraphs. If the {listall} argument is given
and it is TRUE, return all digraphs, including the default
digraphs. Otherwise, return only user-defined digraphs.
Also see |digraph_get()|.
Examples: >
" Get user-defined digraphs
:echo digraph_getlist()
" Get all the digraphs, including default digraphs
:echo digraph_getlist(1)
<
Can also be used as a |method|: >
GetNumber()->digraph_getlist()
<
digraph_set({chars}, {digraph}) *digraph_set()*
Add digraph {chars} to the list. {chars} must be a string
with two characters. {digraph} is a string with one UTF-8
encoded character. *E1215*
Be careful, composing characters are NOT ignored. This
function is similar to |:digraphs| command, but useful to add
digraphs start with a white space.
The function result is v:true if |digraph| is registered. If
this fails an error message is given and v:false is returned.
If you want to define multiple digraphs at once, you can use
|digraph_setlist()|.
Example: >
call digraph_set(' ', 'あ')
<
Can be used as a |method|: >
GetString()->digraph_set('あ')
<
digraph_setlist({digraphlist}) *digraph_setlist()*
Similar to |digraph_set()| but this function can add multiple
digraphs at once. {digraphlist} is a list composed of lists,
where each list contains two strings with {chars} and
{digraph} as in |digraph_set()|. *E1216*
Example: >
call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
<
It is similar to the following: >
for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
call digraph_set(chars, digraph)
endfor
< Except that the function returns after the first error,
following digraphs will not be added.
Can be used as a |method|: >
GetList()->digraph_setlist()
<
empty({expr}) *empty()*
Return the Number 1 if {expr} is empty, zero otherwise.

3
runtime/doc/digraph.txt
View File

@ -35,6 +35,9 @@ An alternative is using the 'keymap' option.
< Avoid defining a digraph with '_' (underscore) as the
first character, it has a special meaning in the
future.
NOTE: This command cannot add a digraph that starts
with a white space. If you want to add such digraph,
you can use |digraph_set()| instead.
Example of the output of ":digraphs": >
TH Þ 222 ss ß 223 a! à 224 a' á 225 a> â 226 a? ã 227 a: ä 228

4
runtime/doc/usr_41.txt
View File

@ -960,6 +960,10 @@ Window size and position: *window-size-functions*
winrestview() restore saved view of current window
Mappings: *mapping-functions*
digraph_get() get |digraph|
digraph_getlist() get all |digraph|s
digraph_set() register |digraph|
digraph_setlist() register multiple |digraph|s
hasmapto() check if a mapping exists
mapcheck() check if a matching mapping exists
maparg() get rhs of a mapping

279
src/nvim/digraph.c
View File

@ -12,6 +12,7 @@
#include "nvim/ascii.h"
#include "nvim/charset.h"
#include "nvim/digraph.h"
#include "nvim/eval/typval.h"
#include "nvim/ex_cmds2.h"
#include "nvim/ex_docmd.h"
#include "nvim/ex_getln.h"
@ -34,6 +35,12 @@ typedef struct digraph {
result_T result;
} digr_T;
static char e_digraph_must_be_just_two_characters_str[]
= N_("E1214: Digraph must be just two characters: %s");
static char e_digraph_argument_must_be_one_character_str[]
= N_("E1215: Digraph must be one character: %s");
static char e_digraph_setlist_argument_must_be_list_of_lists_with_two_items[]
= N_("E1216: digraph_setlist() argument must be a list of lists with two items");
#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "digraph.c.generated.h"
@ -1458,7 +1465,7 @@ int do_digraph(int c)
backspaced = -1;
} else if (p_dg) {
if (backspaced >= 0) {
c = getdigraph(backspaced, c, false);
c = digraph_get(backspaced, c, false);
}
backspaced = -1;
@ -1475,17 +1482,16 @@ int do_digraph(int c)
char_u *get_digraph_for_char(int val_arg)
{
const int val = val_arg;
digr_T *dp;
const digr_T *dp;
static char_u r[3];
for (int use_defaults = 0; use_defaults <= 1; use_defaults++) {
if (use_defaults == 0) {
dp = (digr_T *)user_digraphs.ga_data;
dp = (const digr_T *)user_digraphs.ga_data;
} else {
dp = digraphdefault;
}
for (int i = 0;
use_defaults ? dp->char1 != NUL : i < user_digraphs.ga_len; i++) {
for (int i = 0; use_defaults ? dp->char1 != NUL : i < user_digraphs.ga_len; i++) {
if (dp->result == val) {
r[0] = dp->char1;
r[1] = dp->char2;
@ -1530,7 +1536,7 @@ int get_digraph(bool cmdline)
if (cc != ESC) {
// ESC cancels CTRL-K
return getdigraph(c, cc, true);
return digraph_get(c, cc, true);
}
}
return NUL;
@ -1553,7 +1559,7 @@ static int getexactdigraph(int char1, int char2, bool meta_char)
}
// Search user digraphs first.
digr_T *dp = (digr_T *)user_digraphs.ga_data;
const digr_T *dp = (const digr_T *)user_digraphs.ga_data;
for (int i = 0; i < user_digraphs.ga_len; i++) {
if (((int)dp->char1 == char1) && ((int)dp->char2 == char2)) {
retval = dp->result;
@ -1594,7 +1600,7 @@ static int getexactdigraph(int char1, int char2, bool meta_char)
/// @param meta_char
///
/// @return The digraph.
int getdigraph(int char1, int char2, bool meta_char)
int digraph_get(int char1, int char2, bool meta_char)
{
int retval;
@ -1607,6 +1613,44 @@ int getdigraph(int char1, int char2, bool meta_char)
return retval;
}
/// Add a digraph to the digraph table.
static void registerdigraph(int char1, int char2, int n)
{
// If the digraph already exists, replace "result".
digr_T *dp = (digr_T *)user_digraphs.ga_data;
for (int i = 0; i < user_digraphs.ga_len; i++) {
if ((int)dp->char1 == char1 && (int)dp->char2 == char2) {
dp->result = n;
return;
}
dp++;
}
// Add a new digraph to the table.
dp = GA_APPEND_VIA_PTR(digr_T, &user_digraphs);
dp->char1 = (char_u)char1;
dp->char2 = (char_u)char2;
dp->result = n;
}
/// Check the characters are valid for a digraph.
/// If they are valid, returns true; otherwise, give an error message and
/// returns false.
bool check_digraph_chars_valid(int char1, int char2)
{
if (char2 == 0) {
char_u msg[MB_MAXBYTES + 1];
msg[utf_char2bytes(char1, msg)] = NUL;
semsg(_(e_digraph_must_be_just_two_characters_str), msg);
return false;
}
if (char1 == ESC || char2 == ESC) {
emsg(_("E104: Escape not allowed in digraph"));
return false;
}
return true;
}
/// Add the digraphs in the argument to the digraph table.
/// format: {c1}{c2} char {c1}{c2} char ...
///
@ -1622,15 +1666,10 @@ void putdigraph(char_u *str)
char_u char1 = *str++;
char_u char2 = *str++;
if (char2 == 0) {
emsg(_(e_invarg));
if (!check_digraph_chars_valid(char1, char2)) {
return;
}
if ((char1 == ESC) || (char2 == ESC)) {
emsg(_("E104: Escape not allowed in digraph"));
return;
}
str = skipwhite(str);
if (!ascii_isdigit(*str)) {
@ -1639,25 +1678,7 @@ void putdigraph(char_u *str)
}
int n = getdigits_int(&str, true, 0);
// If the digraph already exists, replace the result.
digr_T *dp = (digr_T *)user_digraphs.ga_data;
int i;
for (i = 0; i < user_digraphs.ga_len; i++) {
if (((int)dp->char1 == char1) && ((int)dp->char2 == char2)) {
dp->result = n;
break;
}
dp++;
}
// Add a new digraph to the table.
if (i == user_digraphs.ga_len) {
dp = GA_APPEND_VIA_PTR(digr_T, &user_digraphs);
dp->char1 = char1;
dp->char2 = char2;
dp->result = n;
}
registerdigraph(char1, char2, n);
}
}
@ -1677,7 +1698,7 @@ void listdigraphs(bool use_headers)
msg_putchar('\n');
digr_T *dp = digraphdefault;
const digr_T *dp = digraphdefault;
for (int i = 0; dp->char1 != NUL && !got_int; i++) {
digr_T tmp;
@ -1687,15 +1708,14 @@ void listdigraphs(bool use_headers)
tmp.char2 = dp->char2;
tmp.result = getexactdigraph(tmp.char1, tmp.char2, false);
if ((tmp.result != 0)
&& (tmp.result != tmp.char2)) {
if (tmp.result != 0 && tmp.result != tmp.char2) {
printdigraph(&tmp, use_headers ? &previous : NULL);
}
dp++;
fast_breakcheck();
}
dp = (digr_T *)user_digraphs.ga_data;
dp = (const digr_T *)user_digraphs.ga_data;
for (int i = 0; i < user_digraphs.ga_len && !got_int; i++) {
if (previous >= 0 && use_headers) {
digraph_header(_("Custom"));
@ -1707,6 +1727,50 @@ void listdigraphs(bool use_headers)
}
}
static void digraph_getlist_appendpair(const digr_T *dp, list_T *l)
{
list_T *l2 = tv_list_alloc(2);
tv_list_append_list(l, l2);
char_u buf[30];
buf[0] = dp->char1;
buf[1] = dp->char2;
buf[2] = NUL;
tv_list_append_string(l2, (char *)buf, -1);
char_u *p = buf;
p += utf_char2bytes(dp->result, p);
*p = NUL;
tv_list_append_string(l2, (char *)buf, -1);
}
void digraph_getlist_common(bool list_all, typval_T *rettv)
{
tv_list_alloc_ret(rettv, (int)sizeof(digraphdefault) + user_digraphs.ga_len);
const digr_T *dp;
if (list_all) {
dp = digraphdefault;
for (int i = 0; dp->char1 != NUL && !got_int; i++) {
digr_T tmp;
tmp.char1 = dp->char1;
tmp.char2 = dp->char2;
tmp.result = getexactdigraph(tmp.char1, tmp.char2, false);
if (tmp.result != 0 && tmp.result != tmp.char2) {
digraph_getlist_appendpair(&tmp, rettv->vval.v_list);
}
dp++;
}
}
dp = (const digr_T *)user_digraphs.ga_data;
for (int i = 0; i < user_digraphs.ga_len && !got_int; i++) {
digraph_getlist_appendpair(dp, rettv->vval.v_list);
dp++;
}
}
struct dg_header_entry {
int dg_start;
const char *dg_header;
@ -1797,6 +1861,147 @@ static void printdigraph(const digr_T *dp, result_T *previous)
}
}
/// Get the two digraph characters from a typval.
/// @return OK or FAIL.
static int get_digraph_chars(const typval_T *arg, int *char1, int *char2)
{
char buf_chars[NUMBUFLEN];
const char *chars = tv_get_string_buf_chk(arg, buf_chars);
const char_u *p = (const char_u *)chars;
if (p != NULL) {
if (*p != NUL) {
*char1 = mb_cptr2char_adv(&p);
if (*p != NUL) {
*char2 = mb_cptr2char_adv(&p);
if (*p == NUL) {
if (check_digraph_chars_valid(*char1, *char2)) {
return OK;
}
return FAIL;
}
}
}
}
semsg(_(e_digraph_must_be_just_two_characters_str), chars);
return FAIL;
}
static bool digraph_set_common(const typval_T *argchars, const typval_T *argdigraph)
{
int char1, char2;
if (get_digraph_chars(argchars, &char1, &char2) == FAIL) {
return false;
}
char buf_digraph[NUMBUFLEN];
const char *digraph = tv_get_string_buf_chk(argdigraph, buf_digraph);
if (digraph == NULL) {
return false;
}
const char_u *p = (const char_u *)digraph;
int n = mb_cptr2char_adv(&p);
if (*p != NUL) {
semsg(_(e_digraph_argument_must_be_one_character_str), digraph);
return false;
}
registerdigraph(char1, char2, n);
return true;
}
/// "digraph_get()" function
void f_digraph_get(typval_T *argvars, typval_T *rettv, FunPtr fptr)
{
rettv->v_type = VAR_STRING;
rettv->vval.v_string = NULL; // Return empty string for failure
const char *digraphs = tv_get_string_chk(&argvars[0]);
if (digraphs == NULL) {
return;
}
if (STRLEN(digraphs) != 2) {
semsg(_(e_digraph_must_be_just_two_characters_str), digraphs);
return;
}
int code = digraph_get(digraphs[0], digraphs[1], false);
char_u buf[NUMBUFLEN];
buf[utf_char2bytes(code, buf)] = NUL;
rettv->vval.v_string = vim_strsave(buf);
}
/// "digraph_getlist()" function
void f_digraph_getlist(typval_T *argvars, typval_T *rettv, FunPtr fptr)
{
bool flag_list_all;
if (argvars[0].v_type == VAR_UNKNOWN) {
flag_list_all = false;
} else {
bool error = false;
varnumber_T flag = tv_get_number_chk(&argvars[0], &error);
if (error) {
return;
}
flag_list_all = flag != 0;
}
digraph_getlist_common(flag_list_all, rettv);
}
/// "digraph_set()" function
void f_digraph_set(typval_T *argvars, typval_T *rettv, FunPtr fptr)
{
rettv->v_type = VAR_BOOL;
rettv->vval.v_bool = kBoolVarFalse;
if (!digraph_set_common(&argvars[0], &argvars[1])) {
return;
}
rettv->vval.v_bool = kBoolVarTrue;
}
/// "digraph_setlist()" function
void f_digraph_setlist(typval_T *argvars, typval_T *rettv, FunPtr fptr)
{
rettv->v_type = VAR_BOOL;
rettv->vval.v_bool = kBoolVarFalse;
if (argvars[0].v_type != VAR_LIST) {
emsg(_(e_digraph_setlist_argument_must_be_list_of_lists_with_two_items));
return;
}
list_T *pl = argvars[0].vval.v_list;
if (pl == NULL) {
// Empty list always results in success.
rettv->vval.v_bool = kBoolVarTrue;
return;
}
TV_LIST_ITER_CONST(pl, pli, {
if (TV_LIST_ITEM_TV(pli)->v_type != VAR_LIST) {
emsg(_(e_digraph_setlist_argument_must_be_list_of_lists_with_two_items));
return;
}
list_T *l = TV_LIST_ITEM_TV(pli)->vval.v_list;
if (l == NULL || tv_list_len(l) != 2) {
emsg(_(e_digraph_setlist_argument_must_be_list_of_lists_with_two_items));
return;
}
if (!digraph_set_common(TV_LIST_ITEM_TV(tv_list_first(l)),
TV_LIST_ITEM_TV(TV_LIST_ITEM_NEXT(l, tv_list_first(l))))) {
return;
}
});
rettv->vval.v_bool = kBoolVarTrue;
}
/// structure used for b_kmap_ga.ga_data
typedef struct {
char_u *from;

1
src/nvim/digraph.h
View File

@ -2,6 +2,7 @@
#define NVIM_DIGRAPH_H
#include "nvim/ex_cmds_defs.h"
#include "nvim/eval/funcs.h"
#include "nvim/types.h"
#ifdef INCLUDE_GENERATED_DECLARATIONS

2
src/nvim/edit.c
View File

@ -9260,7 +9260,7 @@ static int ins_digraph(void)
}
if (cc != ESC) {
AppendToRedobuff(CTRL_V_STR);
c = getdigraph(c, cc, true);
c = digraph_get(c, cc, true);
clear_showcmd();
return c;
}

4
src/nvim/eval.lua
View File

@ -102,6 +102,10 @@ return {
did_filetype={},
diff_filler={args=1, base=1},
diff_hlID={args=2, base=1},
digraph_get={args=1, base=1},
digraph_getlist={args={0, 1}, base=1},
digraph_set={args=2, base=1},
digraph_setlist={args=1, base=1},
empty={args=1, base=1},
environ={},
escape={args=2, base=1},

1
src/nvim/eval/funcs.c
View File

@ -15,6 +15,7 @@
#include "nvim/charset.h"
#include "nvim/context.h"
#include "nvim/cursor.h"
#include "nvim/digraph.h"
#include "nvim/diff.h"
#include "nvim/edit.h"
#include "nvim/eval.h"

83
src/nvim/testdir/test_digraph.vim
View File

@ -212,7 +212,7 @@ func Test_digraphs()
call Put_Dig("el")
call assert_equal(['␀', 'ü', '∞', 'l'], getline(line('.')-3,line('.')))
call assert_fails('digraph xy z', 'E39:')
call assert_fails('digraph x', 'E474:')
call assert_fails('digraph x', 'E1214:')
bw!
endfunc
@ -505,4 +505,85 @@ func Test_entering_digraph()
call StopVimInTerminal(buf)
endfunc
func Test_digraph_set_function()
new
call digraph_set('aa', 'あ')
call Put_Dig('aa')
call assert_equal('あ', getline('$'))
call digraph_set(' i', 'い')
call Put_Dig(' i')
call assert_equal('い', getline('$'))
call digraph_set(' ', 'う')
call Put_Dig(' ')
call assert_equal('う', getline('$'))
eval 'aa'->digraph_set('え')
call Put_Dig('aa')
call assert_equal('え', getline('$'))
call assert_fails('call digraph_set("aaa", "あ")', 'E1214: Digraph must be just two characters: aaa')
call assert_fails('call digraph_set("b", "あ")', 'E1214: Digraph must be just two characters: b')
call assert_fails('call digraph_set("あ", "あ")', 'E1214: Digraph must be just two characters: あ')
call assert_fails('call digraph_set("aa", "ああ")', 'E1215: Digraph must be one character: ああ')
call assert_fails('call digraph_set("aa", "か" .. nr2char(0x3099))', 'E1215: Digraph must be one character: か' .. nr2char(0x3099))
bwipe!
endfunc
func Test_digraph_get_function()
" Built-in digraphs
call assert_equal('∞', digraph_get('00'))
" User-defined digraphs
call digraph_set('aa', 'あ')
call digraph_set(' i', 'い')
call digraph_set(' ', 'う')
call assert_equal('あ', digraph_get('aa'))
call assert_equal('あ', 'aa'->digraph_get())
call assert_equal('い', digraph_get(' i'))
call assert_equal('う', digraph_get(' '))
call assert_fails('call digraph_get("aaa")', 'E1214: Digraph must be just two characters: aaa')
call assert_fails('call digraph_get("b")', 'E1214: Digraph must be just two characters: b')
endfunc
func Test_digraph_get_function_encode()
throw 'Skipped: Nvim does not support setting encoding=japan'
CheckFeature iconv
let testcases = {
\'00': '∞',
\'aa': 'あ',
\}
for [key, ch] in items(testcases)
call digraph_set(key, ch)
set encoding=japan
call assert_equal(iconv(ch, 'utf-8', 'japan'), digraph_get(key))
set encoding=utf-8
endfor
endfunc
func Test_digraph_setlist_function()
call digraph_setlist([['aa', 'き'], ['bb', 'く']])
call assert_equal('き', digraph_get('aa'))
call assert_equal('く', digraph_get('bb'))
call assert_fails('call digraph_setlist([[]])', 'E1216:')
call assert_fails('call digraph_setlist([["aa", "b", "cc"]])', '1216:')
call assert_fails('call digraph_setlist([["あ", "あ"]])', 'E1214: Digraph must be just two characters: あ')
endfunc
func Test_digraph_getlist_function()
" Make sure user-defined digraphs are defined
call digraph_setlist([['aa', 'き'], ['bb', 'く']])
for pair in digraph_getlist(1)
call assert_equal(digraph_get(pair[0]), pair[1])
endfor
" We don't know how many digraphs are registered before, so check the number
" of digraphs returned.
call assert_equal(digraph_getlist()->len(), digraph_getlist(0)->len())
call assert_notequal((digraph_getlist()->len()), digraph_getlist(1)->len())
endfunc
" vim: shiftwidth=2 sts=2 expandtab