fix(tui): more work in the TUI

Author: bfredl

runtime/doc/api.txt

@@ -717,15 +717,19 @@ nvim_del_var({name})                                          *nvim_del_var()*
     Parameters: ~
       • {name}  Variable name
 
-nvim_echo({chunks}, {history}, {opts})                           *nvim_echo()*
+nvim_echo({chunks}, {history}, {*opts})                          *nvim_echo()*
     Echo a message.
 
     Parameters: ~
       • {chunks}   A list of [text, hl_group] arrays, each representing a text
                    chunk with specified highlight. `hl_group` element can be
                    omitted for no highlight.
       • {history}  if true, add to |message-history|.
-      • {opts}     Optional parameters. Reserved for future use.
+      • {opts}     Optional parameters.
+                   • verbose: Message was printed as a result of 'verbose'
+                     option if Nvim was invoked with -V3log_file, the message
+                     will be redirected to the log_file and surpressed from
+                     direct output.
 
 nvim_err_write({str})                                       *nvim_err_write()*
     Writes a message to the Vim error buffer. Does not append "\n", the
@@ -3467,6 +3471,12 @@ nvim_ui_pum_set_height({height})                    *nvim_ui_pum_set_height()*
     Parameters: ~
       • {height}  Popupmenu height, must be greater than zero.
 
+nvim_ui_set_focus({gained})                              *nvim_ui_set_focus()*
+    Tells the nvim server if focus was gained by the GUI or not.
+
+    Attributes: ~
+        |RPC| only
+
 nvim_ui_set_option({name}, {value})                     *nvim_ui_set_option()*
     TODO: Documentation
 

runtime/doc/news.txt

@@ -89,13 +89,22 @@ The following new APIs or features were added.
 
   See https://github.com/neovim/neovim/pull/14537.
 
+• |--remote-ui| option was added to connect to a remote instance and display
+  in it in a |TUI| in the local terminal. This can be used run a headless nvim
+  instance in the background and display its UI on demand, which previously
+  only was possible usiing a external UI implementation.
+
 ==============================================================================
 CHANGED FEATURES                                                 *news-changes*
 
 The following changes to existing APIs or features add new behavior.
 
 • 'exrc' is no longer marked deprecated.
 
+• the |TUI| is changed to run in a separate process (previously, a separate
+  thread was used). This is not supposed to be a visible change to the user,
+  but might be the cause of subtle changes of behavior and bugs.
+
 ==============================================================================
 REMOVED FEATURES                                                 *news-removed*
 

runtime/doc/remote.txt

@@ -52,6 +52,10 @@ The following command line arguments are available:
 								*--remote-expr*
    --remote-expr {expr}		Evaluate {expr} in server and print the result
 				on stdout.
+								*--remote-ui*
+   --remote-ui {expr}		Display the UI of the server in the terminal.
+				Fully interactive: keyboard and mouse input
+				are forwarded to the server.
 								*--server*
    --server {addr}		Connect to the named pipe or socket at the
 				given address for executing remote commands.

src/nvim/api/keysets.lua

@@ -126,6 +126,8 @@ return {
     "global_link";
     "fallback";
     "blend";
+    "fg_indexed";
+    "bg_indexed";
   };
   highlight_cterm = {
     "bold";
@@ -219,5 +221,8 @@ return {
   cmd_opts = {
     "output";
   };
+  echo_opts = {
+    "verbose";
+  };
 }
 

src/nvim/api/vim.c

@@ -726,22 +726,31 @@ void nvim_set_vvar(String name, Object value, Error *err)
 ///                text chunk with specified highlight. `hl_group` element
 ///                can be omitted for no highlight.
 /// @param history  if true, add to |message-history|.
-/// @param opts  Optional parameters. Reserved for future use.
-void nvim_echo(Array chunks, Boolean history, Dictionary opts, Error *err)
+/// @param opts  Optional parameters.
+///          - verbose: Message was printed as a result of 'verbose' option
+///            if Nvim was invoked with -V3log_file, the message will be
+///            redirected to the log_file and surpressed from direct output.
+void nvim_echo(Array chunks, Boolean history, Dict(echo_opts) *opts, Error *err)
   FUNC_API_SINCE(7)
 {
   HlMessage hl_msg = parse_hl_msg(chunks, err);
   if (ERROR_SET(err)) {
     goto error;
   }
 
-  if (opts.size > 0) {
-    api_set_error(err, kErrorTypeValidation, "opts dict isn't empty");
-    goto error;
+  bool verbose = api_object_to_bool(opts->verbose, "verbose", false, err);
+
+  if (verbose) {
+    verbose_enter();
   }
 
   msg_multiattr(hl_msg, history ? "echomsg" : "echo", history);
 
+  if (verbose) {
+    verbose_leave();
+    verbose_stop();  // flush now
+  }
+
   if (history) {
     // history takes ownership
     return;
@@ -1204,6 +1213,12 @@ Boolean nvim_paste(String data, Boolean crlf, Integer phase, Error *err)
     draining = false;
   }
 
+  // TODO(bfredl): ugly, maybe only when notification?
+  if (ERROR_SET(err)) {
+    semsg("paste: %s", err->msg);
+    api_clear_error(err);
+  }
+
   return !cancel;
 }
 

src/nvim/charset.c

@@ -418,6 +418,17 @@ char *transstr(const char *const s, bool untab)
   return buf;
 }
 
+size_t kv_transstr(StringBuilder *str, const char *const s, bool untab)
+{
+  // Compute the length of the result, taking account of unprintable
+  // multi-byte characters.
+  const size_t len = transstr_len(s, untab);
+  kv_ensure_space(*str, len + 1);
+  transstr_buf(s, str->items + str->size, len + 1, untab);
+  str->size += len;  // do not include NUL byte
+  return len;
+}
+
 /// Convert the string "str[orglen]" to do ignore-case comparing.
 /// Use the current locale.
 ///

src/nvim/charset.h

@@ -7,6 +7,7 @@
 #include "nvim/eval/typval.h"
 #include "nvim/option_defs.h"
 #include "nvim/pos.h"
+#include "nvim/strings.h"
 #include "nvim/types.h"
 
 /// Return the folded-case equivalent of the given character

src/nvim/event/libuv_process.c

@@ -47,8 +47,7 @@ int libuv_process_spawn(LibuvProcess *uvproc)
   uvproc->uvstdio[1].flags = UV_IGNORE;
   uvproc->uvstdio[2].flags = UV_IGNORE;
 
-  // TODO: this should just be single flag!
-  if (TUI_process && !is_remote_client && !stdin_isatty) {
+  if (ui_client_embed && !stdin_isatty) {
     uvproc->uvopts.stdio_count = 4;
     uvproc->uvstdio[3].data.fd = 0;
     uvproc->uvstdio[3].flags = UV_INHERIT_FD;

src/nvim/event/process.c

@@ -404,8 +404,7 @@ static void on_process_exit(Process *proc)
   ILOG("exited: pid=%d status=%d stoptime=%" PRIu64, proc->pid, proc->status,
        proc->stopped_time);
 
-  if (TUI_process && !is_remote_client) {
-    // Set only in "builtin" TUI
+  if (ui_client_embed) {
     server_process_exit_status = proc->status;
   }
   // Process has terminated, but there could still be data to be read from the

src/nvim/generators/gen_api_dispatch.lua

@@ -363,7 +363,7 @@ for i = 1, #functions do
           -- if the function recieves the array args, pass it the second argument
           output:write('args, ')
         end
-        output:write(call_args)  
+        output:write(call_args)
       else
         output:write('channel_id')
         if fn.receives_array_args then