patch 8.2.1444: error messages are spread out and names can be confusing

brammool · brammool · commit bc4c505166dc · 2020-08-13T22:47:35.000+02:00
Problem:    Error messages are spread out and names can be confusing.
Solution:   Start moving error messages to a separate file and use clear
            names.
diff --git a/Filelist b/Filelist
@@ -45,6 +45,7 @@ SRC_ALL =	\
 		src/drawline.c \
 		src/drawscreen.c \
 		src/edit.c \
+		src/errors.h \
 		src/eval.c \
 		src/evalbuffer.c \
 		src/evalfunc.c \
diff --git a/src/Make_cyg_ming.mak b/src/Make_cyg_ming.mak
@@ -1107,7 +1107,7 @@ cmdidxs: ex_cmds.h
 	vim --clean -X --not-a-term -u create_cmdidxs.vim
 
 ###########################################################################
-INCL =	vim.h alloc.h ascii.h ex_cmds.h feature.h globals.h \
+INCL =	vim.h alloc.h ascii.h ex_cmds.h feature.h errors.h globals.h \
 	keymap.h macros.h option.h os_dos.h os_win32.h proto.h regexp.h \
 	spell.h structs.h term.h beval.h $(NBDEBUG_INCL)
 GUI_INCL = gui.h
diff --git a/src/Make_mvc.mak b/src/Make_mvc.mak
@@ -719,7 +719,7 @@ CFLAGS = $(CFLAGS) $(CFLAGS_DEPR)
 !include Make_all.mak
 !include testdir\Make_all.mak
 
-INCL =	vim.h alloc.h ascii.h ex_cmds.h feature.h globals.h \
+INCL =	vim.h alloc.h ascii.h ex_cmds.h feature.h errors.h globals.h \
 	keymap.h macros.h option.h os_dos.h os_win32.h proto.h regexp.h \
 	spell.h structs.h term.h beval.h $(NBDEBUG_INCL)
 
diff --git a/src/Make_vms.mms b/src/Make_vms.mms
diff --git a/src/Makefile b/src/Makefile
diff --git a/src/dict.c b/src/dict.c
@@ -847,7 +847,7 @@ eval_dict(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int literal)
 	    if (evaluate)
 	    {
 		if (*skipwhite(*arg) == ':')
-		    semsg(_(e_no_white_before), ":");
+		    semsg(_(e_no_white_space_allowed_before), ":");
 		else
 		    semsg(_(e_missing_dict_colon), *arg);
 	    }
@@ -866,7 +866,7 @@ eval_dict(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int literal)
 	}
 	if (vim9script && (*arg)[1] != NUL && !VIM_ISWHITE((*arg)[1]))
 	{
-	    semsg(_(e_white_after), ":");
+	    semsg(_(e_white_space_required_after), ":");
 	    clear_tv(&tvkey);
 	    goto failret;
 	}
@@ -909,7 +909,7 @@ eval_dict(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int literal)
 	{
 	    if (vim9script && (*arg)[1] != NUL && !VIM_ISWHITE((*arg)[1]))
 	    {
-		semsg(_(e_white_after), ",");
+		semsg(_(e_white_space_required_after), ",");
 		goto failret;
 	    }
 	    *arg = skipwhite(*arg + 1);
@@ -924,7 +924,7 @@ eval_dict(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int literal)
 	    if (evaluate)
 	    {
 		if (**arg == ',')
-		    semsg(_(e_no_white_before), ",");
+		    semsg(_(e_no_white_space_allowed_before), ",");
 		else
 		    semsg(_(e_missing_dict_comma), *arg);
 	    }
diff --git a/src/errors.h b/src/errors.h
@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+/*
+ * Definition of error messages, sorted on error number.
+ */
+
+#ifdef FEAT_EVAL
+EXTERN char e_white_space_required_before_and_after[]
+	INIT(= N_("E1004: white space required before and after '%s'"));
+EXTERN char e_cannot_declare_a_scope_variable[]
+	INIT(= N_("E1016: Cannot declare a %s variable: %s"));
+EXTERN char e_cannot_declare_an_environment_variable[]
+	INIT(= N_("E1016: Cannot declare an environment variable: %s"));
+EXTERN char e_const_requires_a_value[]
+	INIT(= N_("E1021: const requires a value"));
+EXTERN char e_type_or_initialization_required[]
+	INIT(= N_("E1022: type or initialization required"));
+EXTERN char e_colon_required_before_a_range[]
+	INIT(= N_("E1050: Colon required before a range"));
+EXTERN char e_no_white_space_allowed_before[]
+	INIT(= N_("E1068: No white space allowed before '%s'"));
+EXTERN char e_white_space_required_after[]
+	INIT(= N_("E1069: white space required after '%s'"));
+EXTERN char e_name_already_defined[]
+	INIT(= N_("E1073: name already defined: %s"));
+EXTERN char e_list_dict_or_blob_required[]
+	INIT(= N_("E1090: List, Dict or Blob required"));
+EXTERN char e_dictionary_not_set[]
+	INIT(= N_("E1103: Dictionary not set"));
+#endif
diff --git a/src/evalvars.c b/src/evalvars.c
@@ -805,7 +805,7 @@ ex_let(exarg_T *eap)
 						   || !IS_WHITE_OR_NUL(*expr)))
 	    {
 		vim_strncpy(op, expr - len, len);
-		semsg(_(e_white_both), op);
+		semsg(_(e_white_space_required_before_and_after), op);
 		i = FAIL;
 	    }
 
diff --git a/src/ex_docmd.c b/src/ex_docmd.c
@@ -1789,7 +1789,7 @@ do_one_cmd(
 	    --ea.cmd;
 	else if (ea.cmd > cmd)
 	{
-	    emsg(_(e_colon_required));
+	    emsg(_(e_colon_required_before_a_range));
 	    goto doend;
 	}
 	p = find_ex_command(&ea, NULL, lookup_scriptvar, NULL);
diff --git a/src/globals.h b/src/globals.h
@@ -1686,7 +1686,6 @@ EXTERN char e_readonlysbx[]	INIT(= N_("E794: Cannot set variable in the sandbox:
 EXTERN char e_stringreq[]	INIT(= N_("E928: String required"));
 EXTERN char e_emptykey[]	INIT(= N_("E713: Cannot use empty key for Dictionary"));
 EXTERN char e_dictreq[]		INIT(= N_("E715: Dictionary required"));
-EXTERN char e_dictnull[]	INIT(= N_("E1103: Dictionary not set"));
 EXTERN char e_listidx[]		INIT(= N_("E684: list index out of range: %ld"));
 EXTERN char e_blobidx[]		INIT(= N_("E979: Blob index out of range: %ld"));
 EXTERN char e_invalblob[]	INIT(= N_("E978: Invalid operation for Blob"));
@@ -1695,7 +1694,6 @@ EXTERN char e_toofewarg[]	INIT(= N_("E119: Not enough arguments for function: %s
 EXTERN char e_func_deleted[]	INIT(= N_("E933: Function was deleted: %s"));
 EXTERN char e_dictkey[]		INIT(= N_("E716: Key not present in Dictionary: %s"));
 EXTERN char e_listreq[]		INIT(= N_("E714: List required"));
-EXTERN char e_listdictblobreq[]	INIT(= N_("E1090: List, Dict or Blob required"));
 EXTERN char e_listblobreq[]	INIT(= N_("E897: List or Blob required"));
 EXTERN char e_list_end[]	INIT(= N_("E697: Missing end of List ']': %s"));
 EXTERN char e_listdictarg[]	INIT(= N_("E712: Argument of %s must be a List or Dictionary"));
@@ -1748,7 +1746,6 @@ EXTERN char e_missing_dict_colon[] INIT(= N_("E720: Missing colon in Dictionary:
 EXTERN char e_duplicate_key[]	INIT(= N_("E721: Duplicate key in Dictionary: \"%s\""));
 EXTERN char e_missing_dict_comma[] INIT(= N_("E722: Missing comma in Dictionary: %s"));
 EXTERN char e_missing_dict_end[]    INIT(= N_("E723: Missing end of Dictionary '}': %s"));
-EXTERN char e_already_defined[] INIT(= N_("E1073: name already defined: %s"));
 #endif
 #ifdef FEAT_CLIENTSERVER
 EXTERN char e_invexprmsg[]	INIT(= N_("E449: Invalid expression received"));
@@ -1791,16 +1788,8 @@ EXTERN char e_endif_without_if[] INIT(= N_("E580: :endif without :if"));
 EXTERN char e_continue[]	INIT(= N_("E586: :continue without :while or :for"));
 EXTERN char e_break[]		INIT(= N_("E587: :break without :while or :for"));
 EXTERN char e_nowhitespace[]	INIT(= N_("E274: No white space allowed before parenthesis"));
-EXTERN char e_white_both[]	INIT(= N_("E1004: white space required before and after '%s'"));
-EXTERN char e_white_after[]	INIT(= N_("E1069: white space required after '%s'"));
-EXTERN char e_no_white_before[] INIT(= N_("E1068: No white space allowed before '%s'"));
 
 EXTERN char e_lock_unlock[]	INIT(= N_("E940: Cannot lock or unlock variable %s"));
-EXTERN char e_const_req_value[] INIT(= N_("E1021: const requires a value"));
-EXTERN char e_type_req[]	INIT(= N_("E1022: type or initialization required"));
-EXTERN char e_declare_var[]	INIT(= N_("E1016: Cannot declare a %s variable: %s"));
-EXTERN char e_declare_env_var[]	INIT(= N_("E1016: Cannot declare an environment variable: %s"));
-EXTERN char e_colon_required[]	INIT(= N_("E1050: Colon required before a range"));
 #endif
 #if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS)
 EXTERN char e_alloc_color[]	INIT(= N_("E254: Cannot allocate color %s"));
diff --git a/src/list.c b/src/list.c
@@ -1204,7 +1204,7 @@ eval_list(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int do_error)
 	{
 	    if (vim9script && !IS_WHITE_OR_NUL((*arg)[1]))
 	    {
-		semsg(_(e_white_after), ",");
+		semsg(_(e_white_space_required_after), ",");
 		goto failret;
 	    }
 	    *arg = skipwhite(*arg + 1);
@@ -1221,7 +1221,7 @@ eval_list(char_u **arg, typval_T *rettv, evalarg_T *evalarg, int do_error)
 	    if (do_error)
 	    {
 		if (**arg == ',')
-		    semsg(_(e_no_white_before), ",");
+		    semsg(_(e_no_white_space_allowed_before), ",");
 		else
 		    semsg(_("E696: Missing comma in List: %s"), *arg);
 	    }
diff --git a/src/userfunc.c b/src/userfunc.c
@@ -119,7 +119,7 @@ one_function_arg(char_u *arg, garray_T *newargs, garray_T *argtypes, int skip)
 	    ++p;
 	    if (!VIM_ISWHITE(*p))
 	    {
-		semsg(_(e_white_after), ":");
+		semsg(_(e_white_space_required_after), ":");
 		return arg;
 	    }
 	    type = skipwhite(p);
@@ -276,7 +276,7 @@ get_function_args(
 		if (!skip && in_vim9script()
 				      && !IS_WHITE_OR_NUL(*p) && *p != endchar)
 		{
-		    semsg(_(e_white_after), ",");
+		    semsg(_(e_white_space_required_after), ",");
 		    goto err_ret;
 		}
 	    }
@@ -3272,7 +3272,7 @@ def_function(exarg_T *eap, char_u *name_arg)
 			  || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
 	    {
 		if (vim9script)
-		    emsg_funcname(e_already_defined, name);
+		    emsg_funcname(e_name_already_defined, name);
 		else
 		    emsg_funcname(e_funcexts, name);
 		goto erret;
diff --git a/src/version.c b/src/version.c
@@ -754,6 +754,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1444,
 /**/
     1443,
 /**/
diff --git a/src/vim.h b/src/vim.h
@@ -2179,6 +2179,7 @@ typedef enum {
 #endif
 
 #include "globals.h"	    // global variables and messages
+#include "errors.h"	    // error messages
 
 /*
  * If console dialog not supported, but GUI dialog is, use the GUI one.
diff --git a/src/vim9compile.c b/src/vim9compile.c
@@ -302,7 +302,7 @@ check_defined(char_u *p, size_t len, cctx_T *cctx)
 	    || find_func_even_dead(p, FALSE, cctx) != NULL)
     {
 	p[len] = c;
-	semsg(_(e_already_defined), p);
+	semsg(_(e_name_already_defined), p);
 	return FAIL;
     }
     p[len] = c;
@@ -2206,14 +2206,14 @@ compile_arguments(char_u **arg, cctx_T *cctx, int *argcount)
 
 	if (*p != ',' && *skipwhite(p) == ',')
 	{
-	    semsg(_(e_no_white_before), ",");
+	    semsg(_(e_no_white_space_allowed_before), ",");
 	    p = skipwhite(p);
 	}
 	if (*p == ',')
 	{
 	    ++p;
 	    if (*p != NUL && !VIM_ISWHITE(*p))
-		semsg(_(e_white_after), ",");
+		semsg(_(e_white_space_required_after), ",");
 	}
 	whitep = p;
 	p = skipwhite(p);
@@ -2431,7 +2431,7 @@ compile_list(char_u **arg, cctx_T *cctx)
 	}
 	if (*p == ',')
 	{
-	    semsg(_(e_no_white_before), ",");
+	    semsg(_(e_no_white_space_allowed_before), ",");
 	    return FAIL;
 	}
 	if (*p == ']')
@@ -2450,7 +2450,7 @@ compile_list(char_u **arg, cctx_T *cctx)
 	    ++p;
 	    if (*p != ']' && !IS_WHITE_OR_NUL(*p))
 	    {
-		semsg(_(e_white_after), ",");
+		semsg(_(e_white_space_required_after), ",");
 		return FAIL;
 	    }
 	}
@@ -2636,15 +2636,15 @@ compile_dict(char_u **arg, cctx_T *cctx, int literal)
 	if (**arg != ':')
 	{
 	    if (*skipwhite(*arg) == ':')
-		semsg(_(e_no_white_before), ":");
+		semsg(_(e_no_white_space_allowed_before), ":");
 	    else
 		semsg(_(e_missing_dict_colon), *arg);
 	    return FAIL;
 	}
 	whitep = *arg + 1;
 	if (!IS_WHITE_OR_NUL(*whitep))
 	{
-	    semsg(_(e_white_after), ":");
+	    semsg(_(e_white_space_required_after), ":");
 	    return FAIL;
 	}
 
@@ -2675,7 +2675,7 @@ compile_dict(char_u **arg, cctx_T *cctx, int literal)
 	}
 	if (IS_WHITE_OR_NUL(*whitep))
 	{
-	    semsg(_(e_no_white_before), ",");
+	    semsg(_(e_no_white_space_allowed_before), ",");
 	    return FAIL;
 	}
 	whitep = *arg + 1;
@@ -3152,7 +3152,7 @@ compile_subscript(
 	    }
 	    else
 	    {
-		emsg(_(e_listdictblobreq));
+		emsg(_(e_list_dict_or_blob_required));
 		return FAIL;
 	    }
 	}
@@ -3469,7 +3469,7 @@ error_white_both(char_u *op, int len)
     char_u	buf[10];
 
     vim_strncpy(buf, op, len);
-    semsg(_(e_white_both), buf);
+    semsg(_(e_white_space_required_before_and_after), buf);
 }
 
 /*
@@ -3493,7 +3493,7 @@ compile_expr7t(char_u **arg, cctx_T *cctx, ppconst_T *ppconst)
 	if (**arg != '>')
 	{
 	    if (*skipwhite(*arg) == '>')
-		semsg(_(e_no_white_before), ">");
+		semsg(_(e_no_white_space_allowed_before), ">");
 	    else
 		emsg(_("E1104: Missing >"));
 	    return FAIL;
@@ -3837,7 +3837,7 @@ compile_and_or(
 
 	    if (!IS_WHITE_OR_NUL(**arg) || !IS_WHITE_OR_NUL(p[2]))
 	    {
-		semsg(_(e_white_both), op);
+		semsg(_(e_white_space_required_before_and_after), op);
 		return FAIL;
 	    }
 
@@ -3978,7 +3978,7 @@ compile_expr1(char_u **arg,  cctx_T *cctx, ppconst_T *ppconst)
 
 	if (!IS_WHITE_OR_NUL(**arg) || !IS_WHITE_OR_NUL(p[1]))
 	{
-	    semsg(_(e_white_both), "?");
+	    semsg(_(e_white_space_required_before_and_after), "?");
 	    return FAIL;
 	}
 
@@ -4037,7 +4037,7 @@ compile_expr1(char_u **arg,  cctx_T *cctx, ppconst_T *ppconst)
 
 	if (!IS_WHITE_OR_NUL(**arg) || !IS_WHITE_OR_NUL(p[1]))
 	{
-	    semsg(_(e_white_both), ":");
+	    semsg(_(e_white_space_required_before_and_after), ":");
 	    return FAIL;
 	}
 
@@ -4337,15 +4337,15 @@ vim9_declare_error(char_u *name)
 	case 'w': scope = _("window"); break;
 	case 't': scope = _("tab"); break;
 	case 'v': scope = "v:"; break;
-	case '$': semsg(_(e_declare_env_var), name);
+	case '$': semsg(_(e_cannot_declare_an_environment_variable), name);
 		  return;
 	case '&': semsg(_("E1052: Cannot declare an option: %s"), name);
 		  return;
 	case '@': semsg(_("E1066: Cannot declare a register: %s"), name);
 		  return;
 	default: return;
     }
-    semsg(_(e_declare_var), scope, name);
+    semsg(_(e_cannot_declare_a_scope_variable), scope, name);
 }
 
 /*
@@ -4724,7 +4724,7 @@ compile_assignment(char_u *arg, exarg_T *eap, cmdidx_T cmdidx, cctx_T *cctx)
 		// parse optional type: "let var: type = expr"
 		if (!VIM_ISWHITE(p[1]))
 		{
-		    semsg(_(e_white_after), ":");
+		    semsg(_(e_white_space_required_after), ":");
 		    goto theend;
 		}
 		p = skipwhite(p + 1);
@@ -4903,12 +4903,12 @@ compile_assignment(char_u *arg, exarg_T *eap, cmdidx_T cmdidx, cctx_T *cctx)
 	    }
 	    else if (cmdidx == CMD_const)
 	    {
-		emsg(_(e_const_req_value));
+		emsg(_(e_const_requires_a_value));
 		goto theend;
 	    }
 	    else if (!has_type || dest == dest_option)
 	    {
-		emsg(_(e_type_req));
+		emsg(_(e_type_or_initialization_required));
 		goto theend;
 	    }
 	    else
@@ -6624,7 +6624,7 @@ compile_def_function(ufunc_T *ufunc, int set_return_type, cctx_T *outer_cctx)
 	    ea.cmd = skip_range(ea.cmd, NULL);
 	    if (ea.cmd > cmd && !starts_with_colon)
 	    {
-		emsg(_(e_colon_required));
+		emsg(_(e_colon_required_before_a_range));
 		goto erret;
 	    }
 	}
diff --git a/src/vim9execute.c b/src/vim9execute.c
diff --git a/src/vim9script.c b/src/vim9script.c
diff --git a/src/vim9type.c b/src/vim9type.c

Original file line number	Diff line number	Diff line change
`@@ -847,7 +847,7 @@ eval_dict(char_u *arg, typval_T rettv, evalarg_T *evalarg, int literal)`
`847`	`847`	`if (evaluate)`
`848`	`848`	`{`
`849`	`849`	`if (skipwhite(arg) == ':')`
`850`		`- semsg(_(e_no_white_before), ":");`
	`850`	`+ semsg(_(e_no_white_space_allowed_before), ":");`
`851`	`851`	`else`
`852`	`852`	`semsg(_(e_missing_dict_colon), *arg);`
`853`	`853`	`}`
`@@ -866,7 +866,7 @@ eval_dict(char_u *arg, typval_T rettv, evalarg_T *evalarg, int literal)`
`866`	`866`	`}`
`867`	`867`	`if (vim9script && (arg)[1] != NUL && !VIM_ISWHITE((arg)[1]))`
`868`	`868`	`{`
`869`		`- semsg(_(e_white_after), ":");`
	`869`	`+ semsg(_(e_white_space_required_after), ":");`
`870`	`870`	`clear_tv(&tvkey);`
`871`	`871`	`goto failret;`
`872`	`872`	`}`
`@@ -909,7 +909,7 @@ eval_dict(char_u *arg, typval_T rettv, evalarg_T *evalarg, int literal)`
`909`	`909`	`{`
`910`	`910`	`if (vim9script && (arg)[1] != NUL && !VIM_ISWHITE((arg)[1]))`
`911`	`911`	`{`
`912`		`- semsg(_(e_white_after), ",");`
	`912`	`+ semsg(_(e_white_space_required_after), ",");`
`913`	`913`	`goto failret;`
`914`	`914`	`}`
`915`	`915`	`arg = skipwhite(arg + 1);`
`@@ -924,7 +924,7 @@ eval_dict(char_u *arg, typval_T rettv, evalarg_T *evalarg, int literal)`
`924`	`924`	`if (evaluate)`
`925`	`925`	`{`
`926`	`926`	`if (**arg == ',')`
`927`		`- semsg(_(e_no_white_before), ",");`
	`927`	`+ semsg(_(e_no_white_space_allowed_before), ",");`
`928`	`928`	`else`
`929`	`929`	`semsg(_(e_missing_dict_comma), *arg);`
`930`	`930`	`}`
Original file line number	Diff line number	Diff line change
`@@ -805,7 +805,7 @@ ex_let(exarg_T *eap)`
`805`	`805`	`\|\| !IS_WHITE_OR_NUL(*expr)))`
`806`	`806`	`{`
`807`	`807`	`vim_strncpy(op, expr - len, len);`
`808`		`- semsg(_(e_white_both), op);`
	`808`	`+ semsg(_(e_white_space_required_before_and_after), op);`
`809`	`809`	`i = FAIL;`
`810`	`810`	`}`
`811`	`811`
Original file line number	Diff line number	Diff line change
`@@ -1789,7 +1789,7 @@ do_one_cmd(`
`1789`	`1789`	`--ea.cmd;`
`1790`	`1790`	`else if (ea.cmd > cmd)`
`1791`	`1791`	`{`
`1792`		`- emsg(_(e_colon_required));`
	`1792`	`+ emsg(_(e_colon_required_before_a_range));`
`1793`	`1793`	`goto doend;`
`1794`	`1794`	`}`
`1795`	`1795`	`p = find_ex_command(&ea, NULL, lookup_scriptvar, NULL);`