1 files changed, 118 insertions, 155 deletions

diff --git a/src/nvim/ui.c b/src/nvim/ui.c
index d3784b6cd3..b85a01814d 100644
--- a/src/nvim/ui.c
+++ b/src/nvim/ui.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>
@@ -5,6 +8,7 @@
 #include <limits.h>
 
 #include "nvim/vim.h"
+#include "nvim/log.h"
 #include "nvim/ui.h"
 #include "nvim/charset.h"
 #include "nvim/cursor.h"
@@ -29,6 +33,7 @@
 #include "nvim/screen.h"
 #include "nvim/syntax.h"
 #include "nvim/window.h"
+#include "nvim/cursor_shape.h"
 #ifdef FEAT_TUI
 # include "nvim/tui/tui.h"
 #else
@@ -43,6 +48,7 @@
 #define MAX_UI_COUNT 16
 
 static UI *uis[MAX_UI_COUNT];
+static bool ui_ext[UI_WIDGETS] = { 0 };
 static size_t ui_count = 0;
 static int row = 0, col = 0;
 static struct {
@@ -52,6 +58,28 @@ static int current_attr_code = 0;
 static bool pending_cursor_update = false;
 static int busy = 0;
 static int height, width;
+static int old_mode_idx = -1;
+
+#if MIN_LOG_LEVEL > DEBUG_LOG_LEVEL
+# define UI_LOG(funname, ...)
+#else
+static size_t uilog_seen = 0;
+static char uilog_last_event[1024] = { 0 };
+# define UI_LOG(funname, ...) \
+  do { \
+    if (strequal(uilog_last_event, STR(funname))) { \
+      uilog_seen++; \
+    } else { \
+      if (uilog_seen > 0) { \
+        do_log(DEBUG_LOG_LEVEL, "ui", 0, true, \
+               "%s (+%zu times...)", uilog_last_event, uilog_seen); \
+      } \
+      DLOG("ui: " STR(funname)); \
+      uilog_seen = 0; \
+      xstrlcpy(uilog_last_event, STR(funname), sizeof(uilog_last_event)); \
+    } \
+  } while (0)
+#endif
 
 // UI_CALL invokes a function on all registered UI instances. The functions can
 // have 0-5 arguments (configurable by SELECT_NTH).
@@ -61,6 +89,7 @@ static int height, width;
 # define UI_CALL(funname, ...) \
     do { \
       flush_cursor_update(); \
+      UI_LOG(funname, 0); \
       for (size_t i = 0; i < ui_count; i++) { \
         UI *ui = uis[i]; \
         UI_CALL_MORE(funname, __VA_ARGS__); \
@@ -70,6 +99,7 @@ static int height, width;
 # define UI_CALL(...) \
     do { \
       flush_cursor_update(); \
+      UI_LOG(__VA_ARGS__, 0); \
       for (size_t i = 0; i < ui_count; i++) { \
         UI *ui = uis[i]; \
         UI_CALL_HELPER(CNT(__VA_ARGS__), __VA_ARGS__); \
@@ -79,10 +109,15 @@ static int height, width;
 #define CNT(...) SELECT_NTH(__VA_ARGS__, MORE, MORE, MORE, MORE, ZERO, ignore)
 #define SELECT_NTH(a1, a2, a3, a4, a5, a6, ...) a6
 #define UI_CALL_HELPER(c, ...) UI_CALL_HELPER2(c, __VA_ARGS__)
+// Resolves to UI_CALL_MORE or UI_CALL_ZERO.
 #define UI_CALL_HELPER2(c, ...) UI_CALL_##c(__VA_ARGS__)
 #define UI_CALL_MORE(method, ...) if (ui->method) ui->method(ui, __VA_ARGS__)
 #define UI_CALL_ZERO(method) if (ui->method) ui->method(ui)
 
+#ifdef INCLUDE_GENERATED_DECLARATIONS
+# include "ui_events_call.generated.h"
+#endif
+
 void ui_builtin_start(void)
 {
 #ifdef FEAT_TUI
@@ -122,24 +157,6 @@ bool ui_active(void)
   return ui_count != 0;
 }
 
-void ui_suspend(void)
-{
-  UI_CALL(suspend);
-  UI_CALL(flush);
-}
-
-void ui_set_title(char *title)
-{
-  UI_CALL(set_title, title);
-  UI_CALL(flush);
-}
-
-void ui_set_icon(char *icon)
-{
-  UI_CALL(set_icon, icon);
-  UI_CALL(flush);
-}
-
 void ui_event(char *name, Array args)
 {
   bool args_consumed = false;
@@ -149,31 +166,45 @@ void ui_event(char *name, Array args)
   }
 }
 
-// May update the shape of the cursor.
-void ui_cursor_shape(void)
-{
-  ui_mode_change();
-}
-
 void ui_refresh(void)
 {
   if (!ui_active()) {
     return;
   }
 
+  if (updating_screen) {
+    ui_schedule_refresh();
+    return;
+  }
+
   int width = INT_MAX, height = INT_MAX;
-  bool pum_external = true;
+  bool ext_widgets[UI_WIDGETS];
+  for (UIWidget i = 0; (int)i < UI_WIDGETS; i++) {
+    ext_widgets[i] = true;
+  }
 
   for (size_t i = 0; i < ui_count; i++) {
     UI *ui = uis[i];
     width = MIN(ui->width, width);
     height = MIN(ui->height, height);
-    pum_external &= ui->pum_external;
+    for (UIWidget i = 0; (int)i < UI_WIDGETS; i++) {
+      ext_widgets[i] &= ui->ui_ext[i];
+    }
   }
 
   row = col = 0;
+
+  int save_p_lz = p_lz;
+  p_lz = false;  // convince redrawing() to return true ...
   screen_resize(width, height);
-  pum_set_external(pum_external);
+  p_lz = save_p_lz;
+
+  for (UIWidget i = 0; (int)i < UI_WIDGETS; i++) {
+    ui_set_external(i, ext_widgets[i]);
+  }
+  ui_mode_info_set();
+  old_mode_idx = -1;
+  ui_cursor_shape();
 }
 
 static void ui_refresh_event(void **argv)
@@ -183,7 +214,7 @@ static void ui_refresh_event(void **argv)
 
 void ui_schedule_refresh(void)
 {
-  loop_schedule(&main_loop, event_create(1, ui_refresh_event, 0));
+  loop_schedule(&main_loop, event_create(ui_refresh_event, 0));
 }
 
 void ui_resize(int new_width, int new_height)
@@ -199,33 +230,23 @@ void ui_resize(int new_width, int new_height)
   sr.bot = height - 1;
   sr.left = 0;
   sr.right = width - 1;
-  UI_CALL(resize, width, height);
+  ui_call_resize(width, height);
 }
 
 void ui_busy_start(void)
 {
   if (!(busy++)) {
-    UI_CALL(busy_start);
+    ui_call_busy_start();
   }
 }
 
 void ui_busy_stop(void)
 {
   if (!(--busy)) {
-    UI_CALL(busy_stop);
+    ui_call_busy_stop();
   }
 }
 
-void ui_mouse_on(void)
-{
-  UI_CALL(mouse_on);
-}
-
-void ui_mouse_off(void)
-{
-  UI_CALL(mouse_off);
-}
-
 void ui_attach_impl(UI *ui)
 {
   if (ui_count == MAX_UI_COUNT) {
@@ -258,16 +279,14 @@ void ui_detach_impl(UI *ui)
     shift_index++;
   }
 
-  if (--ui_count) {
+  if (--ui_count
+      // During teardown/exit the loop was already destroyed, cannot schedule.
+      // https://github.com/neovim/neovim/pull/5119#issuecomment-258667046
+      && !exiting) {
     ui_schedule_refresh();
   }
 }
 
-void ui_clear(void)
-{
-  UI_CALL(clear);
-}
-
 // Set scrolling region for window 'wp'.
 // The region starts 'off' lines from the start of the window.
 // Also set the vertical scroll region for a vertically split window.  Always
@@ -282,7 +301,7 @@ void ui_set_scroll_region(win_T *wp, int off)
     sr.right = wp->w_wincol + wp->w_width - 1;
   }
 
-  UI_CALL(set_scroll_region, sr.top, sr.bot, sr.left, sr.right);
+  ui_call_set_scroll_region(sr.top, sr.bot, sr.left, sr.right);
 }
 
 // Reset scrolling region to the whole screen.
@@ -292,22 +311,7 @@ void ui_reset_scroll_region(void)
   sr.bot = (int)Rows - 1;
   sr.left = 0;
   sr.right = (int)Columns - 1;
-  UI_CALL(set_scroll_region, sr.top, sr.bot, sr.left, sr.right);
-}
-
-void ui_append_lines(int count)
-{
-  UI_CALL(scroll, -count);
-}
-
-void ui_delete_lines(int count)
-{
-  UI_CALL(scroll, count);
-}
-
-void ui_eol_clear(void)
-{
-  UI_CALL(eol_clear);
+  ui_call_set_scroll_region(sr.top, sr.bot, sr.left, sr.right);
 }
 
 void ui_start_highlight(int attr_code)
@@ -332,23 +336,31 @@ void ui_stop_highlight(void)
   set_highlight_args(current_attr_code);
 }
 
-void ui_visual_bell(void)
-{
-  UI_CALL(visual_bell);
-}
-
 void ui_puts(uint8_t *str)
 {
-  uint8_t *ptr = str;
+  uint8_t *p = str;
   uint8_t c;
 
-  while ((c = *ptr)) {
+  while ((c = *p)) {
     if (c < 0x20) {
-      parse_control_character(c);
-      ptr++;
-    } else {
-      send_output(&ptr);
+      abort();
+    }
+
+    size_t clen = (size_t)mb_ptr2len(p);
+    ui_call_put((String){ .data = (char *)p, .size = clen });
+    col++;
+    if (mb_ptr2cells(p) > 1) {
+      // double cell character, blank the next cell
+      ui_call_put((String)STRING_INIT);
+      col++;
+    }
+    if (utf_ambiguous_width(utf_ptr2char(p))) {
+      pending_cursor_update = true;
+    }
+    if (col >= width) {
+      ui_linefeed();
     }
+    p += clen;
   }
 }
 
@@ -368,9 +380,12 @@ void ui_cursor_goto(int new_row, int new_col)
   pending_cursor_update = true;
 }
 
-void ui_update_menu(void)
+void ui_mode_info_set(void)
 {
-    UI_CALL(update_menu);
+  Array style = mode_style_array();
+  bool enabled = (*p_guicursor != NUL);
+  ui_call_mode_info_set(enabled, style);
+  api_free_array(style);
 }
 
 int ui_current_row(void)
@@ -385,47 +400,7 @@ int ui_current_col(void)
 
 void ui_flush(void)
 {
-  UI_CALL(flush);
-}
-
-static void send_output(uint8_t **ptr)
-{
-  uint8_t *p = *ptr;
-
-  while (*p >= 0x20) {
-    size_t clen = (size_t)mb_ptr2len(p);
-    UI_CALL(put, p, (size_t)clen);
-    col++;
-    if (mb_ptr2cells(p) > 1) {
-      // double cell character, blank the next cell
-      UI_CALL(put, NULL, 0);
-      col++;
-    }
-    if (utf_ambiguous_width(utf_ptr2char(p))) {
-      pending_cursor_update = true;
-    }
-    if (col >= width) {
-      ui_linefeed();
-    }
-    p += clen;
-  }
-
-  *ptr = p;
-}
-
-static void parse_control_character(uint8_t c)
-{
-  if (c == '\n') {
-    ui_linefeed();
-  } else if (c == '\r') {
-    ui_carriage_return();
-  } else if (c == '\b') {
-    ui_cursor_left();
-  } else if (c == Ctrl_L) {
-    ui_cursor_right();
-  } else if (c == Ctrl_G) {
-    UI_CALL(bell);
-  }
+  ui_call_flush();
 }
 
 static void set_highlight_args(int attr_code)
@@ -483,65 +458,53 @@ end:
   UI_CALL(highlight_set, (ui->rgb ? rgb_attrs : cterm_attrs));
 }
 
-static void ui_linefeed(void)
+void ui_linefeed(void)
 {
   int new_col = 0;
   int new_row = row;
   if (new_row < sr.bot) {
     new_row++;
   } else {
-    UI_CALL(scroll, 1);
+    ui_call_scroll(1);
   }
   ui_cursor_goto(new_row, new_col);
 }
 
-static void ui_carriage_return(void)
-{
-  int new_col = 0;
-  ui_cursor_goto(row, new_col);
-}
-
-static void ui_cursor_left(void)
-{
-  int new_col = col - 1;
-  assert(new_col >= 0);
-  ui_cursor_goto(row, new_col);
-}
-
-static void ui_cursor_right(void)
-{
-  int new_col = col + 1;
-  assert(new_col < width);
-  ui_cursor_goto(row, new_col);
-}
-
 static void flush_cursor_update(void)
 {
   if (pending_cursor_update) {
     pending_cursor_update = false;
-    UI_CALL(cursor_goto, row, col);
+    ui_call_cursor_goto(row, col);
   }
 }
 
-// Notify that the current mode has changed. Can be used to change cursor
-// shape, for example.
-static void ui_mode_change(void)
+/// Check if current mode has changed.
+/// May update the shape of the cursor.
+void ui_cursor_shape(void)
 {
-  int mode;
   if (!full_screen) {
     return;
   }
-  // Get a simple UI mode out of State.
-  if ((State & REPLACE) == REPLACE) {
-    mode = REPLACE;
-  } else if (State & INSERT) {
-    mode = INSERT;
-  } else if (State & CMDLINE) {
-    mode = CMDLINE;
-  } else {
-    mode = NORMAL;
+  int mode_idx = cursor_get_mode_idx();
+
+  if (old_mode_idx != mode_idx) {
+    old_mode_idx = mode_idx;
+    char *full_name = shape_table[mode_idx].full_name;
+    ui_call_mode_change(cstr_as_string(full_name), mode_idx);
   }
-  UI_CALL(mode_change, mode);
   conceal_check_cursur_line();
 }
 
+/// Returns true if `widget` is externalized.
+bool ui_is_external(UIWidget widget)
+{
+  return ui_ext[widget];
+}
+
+/// Sets `widget` as "external".
+/// Such widgets are not drawn by Nvim; external UIs are expected to handle
+/// higher-level UI events and present the data.
+void ui_set_external(UIWidget widget, bool external)
+{
+  ui_ext[widget] = external;
+}