zsh 0.8.13

Zsh interpreter and parser in Rust
Documentation 
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
43
44
45
46
47
48
49
50
51
52
53

//! A thread pool for handling operations related to the interactive reader
//! which might block, such as file I/O or completions.

use super::{reader, Reader};
use crate::fd_monitor::FdEventSignaller;
use crate::threads::debounce::Debounce;
use crate::threads::ThreadPool;
use std::os::unix::io::RawFd;
use std::sync::Arc;
use std::time::Duration;

/// The maximum number of I/O threads in a pool used to service background reader operations.
const IO_MAX_THREADS: usize = 16;

/// A reader callback after some reader I/O operation completes.
pub(super) type Callback = Box<dyn for<'a> FnOnce(&mut Reader<'a>) + Send>;

/// Separate debouncers for various reader operations.
pub(super) struct Debouncers {
    // The event signaller shared by all debouncers.
    pub event_signaller: Arc<FdEventSignaller>,
    // Debounce autosuggestion computations.
    pub autosuggestions: Debounce<reader::AutosuggestionResult>,
    // Debounce syntax highlighting.
    pub highlight: Debounce<reader::HighlightResult>,
    // Debounce history pager computations. This holds a callback, not a single value,
    // both to demonstrate the technique and because the callback can capture local variables.
    pub history_pager: Debounce<Callback>,
}

impl Debouncers {
    pub fn new() -> Self {
        let pool = ThreadPool::new(1, IO_MAX_THREADS);
        // These timeouts control how long until a thread is considered abandoned and
        // any queued work is assigned to a new thread.
        let event_signaller = Arc::new(FdEventSignaller::new());
        const HIGHLIGHT_TIMEOUT: Duration = Duration::from_millis(500);
        const HISTORY_PAGER_TIMEOUT: Duration = Duration::from_millis(500);
        const AUTOSUGGEST_TIMEOUT: Duration = Duration::from_millis(500);
        Self {
            autosuggestions: Debounce::new(&pool, &event_signaller, AUTOSUGGEST_TIMEOUT),
            highlight: Debounce::new(&pool, &event_signaller, HIGHLIGHT_TIMEOUT),
            history_pager: Debounce::new(&pool, &event_signaller, HISTORY_PAGER_TIMEOUT),
            event_signaller,
        }
    }

    /// Return the read fd of the event signaller.
    /// This may be used with `poll()` or `select()` to multiplex iothread completions with other events.
    pub fn event_signaller_read_fd(&self) -> RawFd {
        self.event_signaller.read_fd()
    }
}