zsh/extensions/

compinit_bg.rs

//! Background compinit pre-warm — extension; no zsh C counterpart.
use crate::compsys::cache::CompsysCache;
use crate::compsys::CompInitResult;
#[allow(unused_imports)]
use crate::ported::vm_helper::ShellExecutor;
#[allow(unused_imports)]
use std::{collections::HashMap, env, path::PathBuf};

/// Result from background compinit thread.
/// Outcome of background `compinit` autoload.
/// zshrs-original — Src/Modules/complete.c blocks on `compinit`
/// inline. The Rust port runs it on the worker pool.
pub struct CompInitBgResult {
    /// `result` field.
    pub result: CompInitResult,
    /// `cache` field.
    pub cache: CompsysCache,
}

// ===========================================================
// Methods moved verbatim from src/ported/vm_helper because their
// C counterpart's source file maps 1:1 to this Rust module.
// Phase: drift
// ===========================================================

// BEGIN moved-from-exec-rs
impl crate::ported::vm_helper::ShellExecutor {
    /// Non-blocking drain of background compinit results.
    /// Call this before any completion lookup (prompt, tab-complete, etc.).
    /// If the background thread hasn't finished yet, this is a no-op.
    pub fn drain_compinit_bg(&mut self) {
        tracing::debug!(target: "compsys_args", pending = self.compinit_pending.is_some(), "drain_compinit_bg ENTER");
        if let Some((rx, start)) = self.compinit_pending.take() {
            match rx.try_recv() {
                Ok(bg) => {
                    let comps = bg.result.comps.len();
                    // `#compdef -k`/`-K` header bindings — must run on the
                    // shell thread (dispatches zle -C + bindkey).
                    crate::compsys::ported::compinit::apply_keybindings(&bg.result);
                    // compinit sh:337/sh:541 — `compdef -na` autoloads every
                    // completer it registers, so `${(k)functions}` holds a stub
                    // for each one (see `register_autoload_stubs`).
                    let mut stubs = crate::compsys::ported::compinit::register_autoload_stubs(
                        crate::compsys::ported::compinit::autoload_stub_names(&bg.result),
                    );
                    // `autoload_stub_names` reads `result.files`, which only a
                    // fresh `$fpath` scan fills: `load_from_cache`
                    // (compinit.rs) rebuilds `comps`/`patcomps`/`postpatcomps`
                    // out of SQLite and leaves `files` empty. The background
                    // thread returns whichever of the two it ended up taking,
                    // so on every cache-hit start the call above registered
                    // ZERO stubs and `${(k)functions}` came back holding no
                    // `_*` name at all -- measured `${#${(M)${(k)functions}:#_*}}`
                    // = 0 against a 1822-entry `$_comps`. `zle -C`'s entry
                    // point `_main_complete` was one of the missing names, so
                    // every completion widget compinit binds called an
                    // undefined function and inserted nothing. The `autoloads`
                    // table carries the same names the scan would have
                    // produced, so read it whenever the file list came back in
                    // the empty cache shape.
                    if bg.result.files.is_empty() {
                        if let Ok(names) = bg.cache.list_autoload_names() {
                            stubs += crate::compsys::ported::compinit::register_autoload_stubs(
                                &names,
                            );
                        }
                    }
                    tracing::info!(stubs, "compinit: autoload stubs from background result");
                    self.set_assoc("_comps".to_string(), bg.result.comps.into_iter().collect());
                    self.set_assoc(
                        "_services".to_string(),
                        bg.result.services.into_iter().collect(),
                    );
                    self.set_assoc(
                        "_patcomps".to_string(),
                        bg.result.patcomps.into_iter().collect(),
                    );
                    self.compsys_cache = std::cell::OnceCell::from(Some(bg.cache));
                    tracing::info!(
                        wall_ms = start.elapsed().as_millis() as u64,
                        comps,
                        "compinit: background results merged"
                    );
                }
                Err(std::sync::mpsc::TryRecvError::Empty) => {
                    // Not ready yet — put the receiver back for next poll
                    self.compinit_pending = Some((rx, start));
                }
                Err(std::sync::mpsc::TryRecvError::Disconnected) => {
                    tracing::warn!("compinit: background thread died without sending results");
                }
            }
        }
    }
    /// Traditional zsh compinit (--zsh-compat mode)
    /// Uses fpath scanning, .zcompdump files, no SQLite
    pub(crate) fn compinit_compat(
        &mut self,
        quiet: bool,
        no_dump: bool,
        dump_file: Option<String>,
        use_cache: bool,
    ) -> i32 {
        let zdotdir = self
            .scalar("ZDOTDIR")
            .or_else(|| std::env::var("ZDOTDIR").ok())
            .unwrap_or_else(|| std::env::var("HOME").unwrap_or_else(|_| "/tmp".to_string()));

        let dump_path = dump_file
            .map(PathBuf::from)
            .unwrap_or_else(|| PathBuf::from(&zdotdir).join(".zcompdump"));

        // -C: Try to use existing .zcompdump if valid
        if use_cache
            && dump_path.exists()
            && crate::compsys::check_dump(&dump_path, &self.fpath, "zshrs-0.1.0")
        {
            // Valid dump - source it to load _comps
            // For now, just rescan (proper impl would source the dump file)
            if !quiet {
                tracing::info!("compinit: .zcompdump valid, rescanning for compat");
            }
        }

        // Full fpath scan (traditional zsh algorithm)
        let result = crate::compsys::compinit(&self.fpath);

        if !quiet {
            tracing::info!(
                functions = result.files_scanned,
                comps = result.comps.len(),
                dirs = result.dirs_scanned,
                ms = result.scan_time_ms,
                "compinit: fpath scan complete"
            );
        }

        // Write .zcompdump unless -D
        if !no_dump {
            let _ = crate::compsys::compdump(&result, &dump_path, "zshrs-0.1.0");
        }

        // compinit sh:337/sh:541 — `compdef -na` autoloads every completer it
        // registers, so `${(k)functions}` holds a stub for each one (see
        // `register_autoload_stubs`).
        crate::compsys::ported::compinit::register_autoload_stubs(
            crate::compsys::ported::compinit::autoload_stub_names(&result),
        );

        // Set up _comps associative array
        self.set_assoc(
            "_comps".to_string(),
            result.comps.clone().into_iter().collect(),
        );
        self.set_assoc(
            "_services".to_string(),
            result.services.clone().into_iter().collect(),
        );
        self.set_assoc(
            "_patcomps".to_string(),
            result.patcomps.clone().into_iter().collect(),
        );

        // `#compdef -k`/`-K` header bindings (^X? _complete_debug,
        // ^Xh _complete_help, …) — the in-shell half of the scan.
        crate::compsys::ported::compinit::apply_keybindings(&result);

        // No SQLite cache in compat mode
        self.compsys_cache = std::cell::OnceCell::from(None);

        0
    }
}
// END moved-from-exec-rs