patch 8.2.3188: Vim9: argument types are not checked at compile time
Problem: Vim9: argument types are not checked at compile time.
Solution: Add several more type checks, also at runtime. (Yegappan
Lakshmanan, closes #8587)
diff --git a/src/typval.c b/src/typval.c
index 9d5903f..29c925d 100644
--- a/src/typval.c
+++ b/src/typval.c
@@ -385,6 +385,16 @@
}
/*
+ * Check for an optional string argument at 'idx'
+ */
+ int
+check_for_opt_string_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_string_arg(args, idx) != FAIL);
+}
+
+/*
* Give an error and return FAIL unless "args[idx]" is a number.
*/
int
@@ -402,6 +412,16 @@
}
/*
+ * Check for an optional number argument at 'idx'
+ */
+ int
+check_for_opt_number_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_number_arg(args, idx) != FAIL);
+}
+
+/*
* Give an error and return FAIL unless "args[idx]" is a bool.
*/
int
@@ -422,6 +442,16 @@
}
/*
+ * Check for an optional bool argument at 'idx'
+ */
+ int
+check_for_opt_bool_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_bool_arg(args, idx) != FAIL);
+}
+
+/*
* Give an error and return FAIL unless "args[idx]" is a list.
*/
int
@@ -439,6 +469,16 @@
}
/*
+ * Check for an optional list argument at 'idx'
+ */
+ int
+check_for_opt_list_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_list_arg(args, idx) != FAIL);
+}
+
+/*
* Give an error and return FAIL unless "args[idx]" is a dict.
*/
int
@@ -456,6 +496,169 @@
}
/*
+ * Check for an optional dict argument at 'idx'
+ */
+ int
+check_for_opt_dict_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_dict_arg(args, idx) != FAIL);
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a blob.
+ */
+ int
+check_for_blob_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_BLOB)
+ {
+ if (idx >= 0)
+ semsg(_(e_blob_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_blobreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a channel or a job.
+ */
+ int
+check_for_chan_or_job_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_CHANNEL && args[idx].v_type != VAR_JOB)
+ {
+ if (idx >= 0)
+ semsg(_(e_chan_or_job_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_chan_or_job_req));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a job.
+ */
+ int
+check_for_job_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_JOB)
+ {
+ if (idx >= 0)
+ semsg(_(e_job_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_jobreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a string or
+ * a number.
+ */
+ int
+check_for_string_or_number_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_STRING && args[idx].v_type != VAR_NUMBER)
+ {
+ if (idx >= 0)
+ semsg(_(e_string_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_stringreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a string or
+ * a number (buffer)
+ */
+ int
+check_for_buffer_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_STRING && args[idx].v_type != VAR_NUMBER)
+ {
+ if (idx >= 0)
+ semsg(_(e_string_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_stringreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a string or
+ * a number (line)
+ */
+ int
+check_for_lnum_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_STRING && args[idx].v_type != VAR_NUMBER)
+ {
+ if (idx >= 0)
+ semsg(_(e_string_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_stringreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a string or
+ * a number (line)
+ */
+ int
+check_for_opt_lnum_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_UNKNOWN
+ && args[idx].v_type != VAR_STRING
+ && args[idx].v_type != VAR_NUMBER)
+ {
+ if (idx >= 0)
+ semsg(_(e_string_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_stringreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Check for an optional string or number argument at 'idx'
+ */
+ int
+check_for_opt_string_or_number_arg(typval_T *args, int idx)
+{
+ return (args[idx].v_type == VAR_UNKNOWN
+ || check_for_string_or_number_arg(args, idx) != FAIL);
+}
+
+/*
+ * Give an error and return FAIL unless "args[idx]" is a string or
+ * a blob.
+ */
+ int
+check_for_string_or_blob_arg(typval_T *args, int idx)
+{
+ if (args[idx].v_type != VAR_STRING && args[idx].v_type != VAR_BLOB)
+ {
+ if (idx >= 0)
+ semsg(_(e_string_required_for_argument_nr), idx + 1);
+ else
+ emsg(_(e_stringreq));
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
* Get the string value of a variable.
* If it is a Number variable, the number is converted into a string.
* tv_get_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!