events: Refactor how event deferral is handled

- Remove all *_set_defer methods and the 'defer' flag from rstream/jobs
- Added {signal,rstream,job}_event_source functions. Each return a pointer that
  represent the event source for the object in question(For signals, a static
  pointer is returned)
- Added a 'source' field to the Event struct, which is set to the appropriate
  value by the code that created the event.
- Added a 'sources' parameter to `event_poll`. It should point to a
  NULL-terminated array of event sources that will be used to decide which
  events should be processed immediately
- Added a 'source_override' parameter to `rstream_new`. This was required to use
  jobs as event sources of RStream instances(When "focusing" on a job, for
  example).
- Extracted `process_from` static function from `event_process`.
- Remove 'defer' parameter from `event_process`, which now operates only on
  deferred events.
- Refactor `channel_send_call` to use the new lock mechanism

What changed in a single sentence: Code that calls `event_poll` have to specify
which event sources should NOT be deferred. This change was necessary for a
number of reasons:

- To fix a bug where due to race conditions, a client request
  could end in the deferred queue in the middle of a `channel_send_call`
  invocation, resulting in a deadlock since the client process would never
  receive a response, and channel_send_call would never return because
  the client would still be waiting for the response.
- To handle "event locking" correctly in recursive `channel_send_call`
  invocations when the frames are waiting for responses from different
  clients. Not much of an issue now since there's only a python client, but
  could break things later.
- To simplify the process of implementing synchronous functions that depend on
  asynchronous events.

1 files changed, 5 insertions, 2 deletions

diff --git a/src/nvim/message.c b/src/nvim/message.c
index dea02e21fa..ef0faa35ee 100644
--- a/src/nvim/message.c
+++ b/src/nvim/message.c
@@ -2074,7 +2074,7 @@ static int do_more_prompt(int typed_char)
     toscroll = 0;
     switch (c) {
     case K_EVENT:
-      event_process(true);
+      event_process();
       break;
     case BS:                    /* scroll one line back */
     case K_BS:
@@ -2734,8 +2734,11 @@ do_dialog (
       retval = 0;
       break;
     default:                  /* Could be a hotkey? */
-      if (c < 0)              /* special keys are ignored here */
+      if (c < 0) {            /* special keys are ignored here */
+        // drain event queue to prevent infinite loop
+        event_process();
         continue;
+      }
       if (c == ':' && ex_cmd) {
         retval = dfltbutton;
         ins_char_typebuf(':');