Merge branch 'master' into luaviml'/lua

src/nvim/api/private/defs.h

@@ -10,9 +10,11 @@
 #define ARRAY_DICT_INIT {.size = 0, .capacity = 0, .items = NULL}
 #define STRING_INIT {.data = NULL, .size = 0}
 #define OBJECT_INIT { .type = kObjectTypeNil }
-#define ERROR_INIT { .set = false }
+#define ERROR_INIT { .type = kErrorTypeNone, .msg = NULL }
 #define REMOTE_TYPE(type) typedef handle_T type
 
+#define ERROR_SET(e) ((e)->type != kErrorTypeNone)
+
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # define ArrayOf(...) Array
 # define DictionaryOf(...) Dictionary
@@ -22,6 +24,7 @@ typedef int handle_T;
 
 // Basic types
 typedef enum {
+  kErrorTypeNone = -1,
   kErrorTypeException,
   kErrorTypeValidation
 } ErrorType;
@@ -59,8 +62,7 @@ static inline bool is_internal_call(const uint64_t channel_id)
 
 typedef struct {
   ErrorType type;
-  char msg[1024];
-  bool set;
+  char *msg;
 } Error;
 
 typedef bool Boolean;

src/nvim/api/private/dispatch.c

@@ -1,3 +1,6 @@
+// This is an open source non-commercial project. Dear PVS-Studio, please check
+// it. PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
+
 #include <inttypes.h>
 #include <stdbool.h>
 #include <stdint.h>

src/nvim/api/private/handle.c

@@ -1,3 +1,6 @@
+// This is an open source non-commercial project. Dear PVS-Studio, please check
+// it. PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
+
 #include <assert.h>
 #include <stdint.h>
 

src/nvim/api/private/helpers.c

@@ -1,3 +1,6 @@
+// This is an open source non-commercial project. Dear PVS-Studio, please check
+// it. PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
+
 #include <assert.h>
 #include <inttypes.h>
 #include <stdbool.h>
@@ -58,7 +61,7 @@ bool try_end(Error *err)
       discard_current_exception();
     }
 
-    api_set_error(err, Exception, _("Keyboard interrupt"));
+    api_set_error(err, kErrorTypeException, "Keyboard interrupt");
     got_int = false;
   } else if (msg_list != NULL && *msg_list != NULL) {
     int should_free;
@@ -66,19 +69,18 @@ bool try_end(Error *err)
                                              ET_ERROR,
                                              NULL,
                                              &should_free);
-    xstrlcpy(err->msg, msg, sizeof(err->msg));
-    err->set = true;
+    api_set_error(err, kErrorTypeException, "%s", msg);
     free_global_msglist();
 
     if (should_free) {
       xfree(msg);
     }
   } else if (did_throw) {
-    api_set_error(err, Exception, "%s", current_exception->value);
+    api_set_error(err, kErrorTypeException, "%s", current_exception->value);
     discard_current_exception();
   }
 
-  return err->set;
+  return ERROR_SET(err);
 }
 
 /// Recursively expands a vimscript value in a dict
@@ -91,8 +93,8 @@ Object dict_get_value(dict_T *dict, String key, Error *err)
   dictitem_T *const di = tv_dict_find(dict, key.data, (ptrdiff_t)key.size);
 
   if (di == NULL) {
-    api_set_error(err, Validation, _("Key not found"));
-    return (Object) OBJECT_INIT;
+    api_set_error(err, kErrorTypeValidation, "Key not found");
+    return (Object)OBJECT_INIT;
   }
 
   return vim_to_object(&di->di_tv);
@@ -115,17 +117,18 @@ Object dict_set_var(dict_T *dict, String key, Object value, bool del,
   Object rv = OBJECT_INIT;
 
   if (dict->dv_lock) {
-    api_set_error(err, Exception, _("Dictionary is locked"));
+    api_set_error(err, kErrorTypeException, "Dictionary is locked");
     return rv;
   }
 
   if (key.size == 0) {
-    api_set_error(err, Validation, _("Empty variable names aren't allowed"));
+    api_set_error(err, kErrorTypeValidation,
+                  "Empty variable names aren't allowed");
     return rv;
   }
 
   if (key.size > INT_MAX) {
-    api_set_error(err, Validation, _("Key length is too high"));
+    api_set_error(err, kErrorTypeValidation, "Key length is too high");
     return rv;
   }
 
@@ -133,13 +136,13 @@ Object dict_set_var(dict_T *dict, String key, Object value, bool del,
 
   if (di != NULL) {
     if (di->di_flags & DI_FLAGS_RO) {
-      api_set_error(err, Exception, _("Key is read-only: %s"), key.data);
+      api_set_error(err, kErrorTypeException, "Key is read-only: %s", key.data);
       return rv;
     } else if (di->di_flags & DI_FLAGS_FIX) {
-      api_set_error(err, Exception, _("Key is fixed: %s"), key.data);
+      api_set_error(err, kErrorTypeException, "Key is fixed: %s", key.data);
       return rv;
     } else if (di->di_flags & DI_FLAGS_LOCK) {
-      api_set_error(err, Exception, _("Key is locked: %s"), key.data);
+      api_set_error(err, kErrorTypeException, "Key is locked: %s", key.data);
       return rv;
     }
   }
@@ -148,7 +151,8 @@ Object dict_set_var(dict_T *dict, String key, Object value, bool del,
     // Delete the key
     if (di == NULL) {
       // Doesn't exist, fail
-      api_set_error(err, Validation, _("Key \"%s\" doesn't exist"), key.data);
+      api_set_error(err, kErrorTypeValidation, "Key does not exist: %s",
+                    key.data);
     } else {
       // Return the old value
       if (retval) {
@@ -200,7 +204,7 @@ Object get_option_from(void *from, int type, String name, Error *err)
   Object rv = OBJECT_INIT;
 
   if (name.size == 0) {
-    api_set_error(err, Validation, _("Empty option name"));
+    api_set_error(err, kErrorTypeValidation, "Empty option name");
     return rv;
   }
 
@@ -212,8 +216,8 @@ Object get_option_from(void *from, int type, String name, Error *err)
 
   if (!flags) {
     api_set_error(err,
-                  Validation,
-                  _("Invalid option name \"%s\""),
+                  kErrorTypeValidation,
+                  "Invalid option name \"%s\"",
                   name.data);
     return rv;
   }
@@ -231,14 +235,14 @@ Object get_option_from(void *from, int type, String name, Error *err)
       rv.data.string.size = strlen(stringval);
     } else {
       api_set_error(err,
-                    Exception,
-                    _("Unable to get value for option \"%s\""),
+                    kErrorTypeException,
+                    "Unable to get value for option \"%s\"",
                     name.data);
     }
   } else {
     api_set_error(err,
-                  Exception,
-                  _("Unknown type for option \"%s\""),
+                  kErrorTypeException,
+                  "Unknown type for option \"%s\"",
                   name.data);
   }
 
@@ -255,7 +259,7 @@ Object get_option_from(void *from, int type, String name, Error *err)
 void set_option_to(void *to, int type, String name, Object value, Error *err)
 {
   if (name.size == 0) {
-    api_set_error(err, Validation, _("Empty option name"));
+    api_set_error(err, kErrorTypeValidation, "Empty option name");
     return;
   }
 
@@ -263,8 +267,8 @@ void set_option_to(void *to, int type, String name, Object value, Error *err)
 
   if (flags == 0) {
     api_set_error(err,
-                  Validation,
-                  _("Invalid option name \"%s\""),
+                  kErrorTypeValidation,
+                  "Invalid option name \"%s\"",
                   name.data);
     return;
   }
@@ -272,15 +276,15 @@ void set_option_to(void *to, int type, String name, Object value, Error *err)
   if (value.type == kObjectTypeNil) {
     if (type == SREQ_GLOBAL) {
       api_set_error(err,
-                    Exception,
-                    _("Unable to unset option \"%s\""),
+                    kErrorTypeException,
+                    "Unable to unset option \"%s\"",
                     name.data);
       return;
     } else if (!(flags & SOPT_GLOBAL)) {
       api_set_error(err,
-                    Exception,
-                    _("Cannot unset option \"%s\" "
-                      "because it doesn't have a global value"),
+                    kErrorTypeException,
+                    "Cannot unset option \"%s\" "
+                    "because it doesn't have a global value",
                     name.data);
       return;
     } else {
@@ -294,8 +298,8 @@ void set_option_to(void *to, int type, String name, Object value, Error *err)
   if (flags & SOPT_BOOL) {
     if (value.type != kObjectTypeBoolean) {
       api_set_error(err,
-                    Validation,
-                    _("Option \"%s\" requires a boolean value"),
+                    kErrorTypeValidation,
+                    "Option \"%s\" requires a boolean value",
                     name.data);
       return;
     }
@@ -305,16 +309,16 @@ void set_option_to(void *to, int type, String name, Object value, Error *err)
   } else if (flags & SOPT_NUM) {
     if (value.type != kObjectTypeInteger) {
       api_set_error(err,
-                    Validation,
-                    _("Option \"%s\" requires an integer value"),
+                    kErrorTypeValidation,
+                    "Option \"%s\" requires an integer value",
                     name.data);
       return;
     }
 
     if (value.data.integer > INT_MAX || value.data.integer < INT_MIN) {
       api_set_error(err,
-                    Validation,
-                    _("Value for option \"%s\" is outside range"),
+                    kErrorTypeValidation,
+                    "Value for option \"%s\" is outside range",
                     name.data);
       return;
     }
@@ -324,8 +328,8 @@ void set_option_to(void *to, int type, String name, Object value, Error *err)
   } else {
     if (value.type != kObjectTypeString) {
       api_set_error(err,
-                    Validation,
-                    _("Option \"%s\" requires a string value"),
+                    kErrorTypeValidation,
+                    "Option \"%s\" requires a string value",
                     name.data);
       return;
     }
@@ -558,13 +562,13 @@ buf_T *find_buffer_by_handle(Buffer buffer, Error *err)
   buf_T *rv = handle_get_buffer(buffer);
 
   if (!rv) {
-    api_set_error(err, Validation, _("Invalid buffer id"));
+    api_set_error(err, kErrorTypeValidation, "Invalid buffer id");
   }
 
   return rv;
 }
 
-win_T * find_window_by_handle(Window window, Error *err)
+win_T *find_window_by_handle(Window window, Error *err)
 {
   if (window == 0) {
     return curwin;
@@ -573,13 +577,13 @@ win_T * find_window_by_handle(Window window, Error *err)
   win_T *rv = handle_get_window(window);
 
   if (!rv) {
-    api_set_error(err, Validation, _("Invalid window id"));
+    api_set_error(err, kErrorTypeValidation, "Invalid window id");
   }
 
   return rv;
 }
 
-tabpage_T * find_tab_by_handle(Tabpage tabpage, Error *err)
+tabpage_T *find_tab_by_handle(Tabpage tabpage, Error *err)
 {
   if (tabpage == 0) {
     return curtab;
@@ -588,7 +592,7 @@ tabpage_T * find_tab_by_handle(Tabpage tabpage, Error *err)
   tabpage_T *rv = handle_get_tabpage(tabpage);
 
   if (!rv) {
-    api_set_error(err, Validation, _("Invalid tabpage id"));
+    api_set_error(err, kErrorTypeValidation, "Invalid tabpage id");
   }
 
   return rv;
@@ -656,7 +660,7 @@ bool object_to_vim(Object obj, typval_T *tv, Error *err)
     case kObjectTypeInteger:
       if (obj.data.integer > VARNUMBER_MAX
           || obj.data.integer < VARNUMBER_MIN) {
-        api_set_error(err, Validation, _("Integer value outside range"));
+        api_set_error(err, kErrorTypeValidation, "Integer value outside range");
         return false;
       }
 
@@ -710,8 +714,8 @@ bool object_to_vim(Object obj, typval_T *tv, Error *err)
         String key = item.key;
 
         if (key.size == 0) {
-          api_set_error(err, Validation,
-                        _("Empty dictionary keys aren't allowed"));
+          api_set_error(err, kErrorTypeValidation,
+                        "Empty dictionary keys aren't allowed");
           // cleanup
           tv_dict_free(dict);
           return false;
@@ -798,6 +802,17 @@ void api_free_dictionary(Dictionary value)
   xfree(value.items);
 }
 
+void api_clear_error(Error *value)
+  FUNC_ATTR_NONNULL_ALL
+{
+  if (!ERROR_SET(value)) {
+    return;
+  }
+  xfree(value->msg);
+  value->msg = NULL;
+  value->type = kErrorTypeNone;
+}
+
 Dictionary api_metadata(void)
 {
   static Dictionary metadata = ARRAY_DICT_INIT;
@@ -927,8 +942,8 @@ static void set_option_value_for(char *key,
           return;
         }
         api_set_error(err,
-                      Exception,
-                      _("Problem while switching windows"));
+                      kErrorTypeException,
+                      "Problem while switching windows");
         return;
       }
       set_option_value_err(key, numval, stringval, opt_flags, err);
@@ -944,7 +959,7 @@ static void set_option_value_for(char *key,
       break;
   }
 
-  if (err->set) {
+  if (ERROR_SET(err)) {
     return;
   }
 
@@ -965,6 +980,26 @@ static void set_option_value_err(char *key,
       return;
     }
 
-    api_set_error(err, Exception, "%s", errmsg);
+    api_set_error(err, kErrorTypeException, "%s", errmsg);
   }
 }
+
+void api_set_error(Error *err, ErrorType errType, const char *format, ...)
+  FUNC_ATTR_NONNULL_ALL
+{
+  assert(kErrorTypeNone != errType);
+  va_list args1;
+  va_list args2;
+  va_start(args1, format);
+  va_copy(args2, args1);
+  int len = vsnprintf(NULL, 0, format, args1);
+  va_end(args1);
+  assert(len >= 0);
+  // Limit error message to 1 MB.
+  size_t bufsize = MIN((size_t)len + 1, 1024 * 1024);
+  err->msg = xmalloc(bufsize);
+  vsnprintf(err->msg, bufsize, format, args2);
+  va_end(args2);
+
+  err->type = errType;
+}

src/nvim/api/private/helpers.h

@@ -8,15 +8,6 @@
 #include "nvim/memory.h"
 #include "nvim/lib/kvec.h"
 
-#define api_set_error(err, errtype, ...) \
-  do { \
-    snprintf((err)->msg, \
-             sizeof((err)->msg), \
-             __VA_ARGS__); \
-    (err)->set = true; \
-    (err)->type = kErrorType##errtype; \
-  } while (0)
-
 #define OBJECT_OBJ(o) o
 
 #define BOOLEAN_OBJ(b) ((Object) { \