src/nvim/event/loop.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

#pragma once

#include <stdbool.h>
#include <uv.h>

#include "klib/kvec.h"
#include "nvim/event/defs.h"  // IWYU pragma: keep
#include "nvim/types_defs.h"  // IWYU pragma: keep

struct loop {
  uv_loop_t uv;
  MultiQueue *events;
  MultiQueue *thread_events;
  // Immediate events.
  // - "Processed after exiting `uv_run()` (to avoid recursion), but before returning from
  //   `loop_poll_events()`." 502aee690c98
  // - Practical consequence (for `main_loop`):
  //    - these are processed by `state_enter()..input_get()` whereas "regular" events
  //      (`main_loop.events`) are processed by `state_enter()..VimState.execute()`
  //    - `state_enter()..input_get()` can be "too early" if you want the event to trigger UI
  //      updates and other user-activity-related side-effects.
  MultiQueue *fast_events;

  // used by process/job-control subsystem
  kvec_t(Proc *) children;
  uv_signal_t children_watcher;
  uv_timer_t children_kill_timer;

  // generic timer, used by loop_poll_events()
  uv_timer_t poll_timer;

  uv_timer_t exit_delay_timer;

  uv_async_t async;
  uv_mutex_t mutex;
  int recursive;
  bool closing;  ///< Set to true if loop_close() has been called
};

#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "event/loop.h.generated.h"
#endif