zshrs 0.12.38

The first compiled Unix shell — bytecode VM, worker pool, AOP intercept, Rkyv caching
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Port of `_vcs_info` from `Completion/Zsh/Function/_vcs_info`.
//!
//! `#compdef vcs_info_hookadd vcs_info_hookdel` — completes the two
//! vcs_info hook-management functions: a hook *type* (first argument) and
//! then any number of hook *function* names (`_vcs_info_hooks`).
//!
//! Full upstream body (32 lines, abridged — head is the `#compdef` line):
//! ```text
//! sh: 3  local -a hook_types=( gen-applied-string … start-up )
//! sh:20  local -a specs
//! sh:21  case $service in
//! sh:22    (vcs_info_hookdel)
//! sh:23      specs=( '-a[remove all occurrences, not just the first]' )
//! sh:24      ;;
//! sh:25  esac
//! sh:28  _arguments : \
//! sh:29    $specs \
//! sh:30    ":hook type:($hook_types)" \
//! sh:31    '*:hook function:_vcs_info_hooks'
//! ```

use crate::compsys::ported::_arguments::_arguments;
use crate::ported::params::getsparam;

/// sh:3-18 — the fixed list of vcs_info hook types, in source order.
const HOOK_TYPES: [&str; 14] = [
    "gen-applied-string",
    "gen-hg-bookmark-string",
    "gen-mqguards-string",
    "gen-unapplied-string",
    "no-vcs",
    "post-backend",
    "post-quilt",
    "pre-addon-quilt",
    "pre-get-data",
    "set-branch-format",
    "set-hgrev-format",
    "set-message",
    "set-patch-format",
    "start-up",
];

/// sh:20-31 — assemble the argument vector passed to `_arguments`.
///
/// `service` is `$service`: `vcs_info_hookdel` gets the extra `-a` spec
/// (sh:22-24). `":hook type:($hook_types)"` splices the hook-type array
/// into a single `(w1 w2 …)` action group (default IFS = space), and the
/// trailing `*:hook function:_vcs_info_hooks` accepts any number of hook
/// function names.
fn build_call(service: &str) -> Vec<String> {
    let mut call: Vec<String> = Vec::new();
    call.push(":".to_string()); // sh:28 — leading `:` (no-op separator arg)

    // sh:21-25 — specs=( … ) only for vcs_info_hookdel.
    if service == "vcs_info_hookdel" {
        call.push("-a[remove all occurrences, not just the first]".to_string());
        // sh:23
    }

    // sh:30 — ":hook type:($hook_types)"
    call.push(format!(":hook type:({})", HOOK_TYPES.join(" ")));
    // sh:31 — '*:hook function:_vcs_info_hooks'
    call.push("*:hook function:_vcs_info_hooks".to_string());

    call
}

/// `_vcs_info` — completion for `vcs_info_hookadd` / `vcs_info_hookdel`.
pub fn _vcs_info(_args: &[String]) -> i32 {
    let _fn_scope = crate::compsys::ported::shared::FnScope::enter("_vcs_info");
    // $service selects the dispatched compdef name (sh:21).
    let service = getsparam("service").unwrap_or_default();
    let call = build_call(&service);
    // sh:28-31 — by NAME so `_arguments` runs under its own `comp_wrapper`
    // frame (c:1556); that frame contains its `compstate[restore]=''`
    // (`_arguments.rs:1130`).
    _arguments(&call)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn hookadd_has_no_extra_spec() {
        let call = build_call("vcs_info_hookadd");
        assert_eq!(call[0], ":");
        assert!(!call.iter().any(|s| s.starts_with("-a[")));
        // Leading `:`, hook-type spec, hook-function spec.
        assert_eq!(call.len(), 3);
        assert_eq!(call.last().unwrap(), "*:hook function:_vcs_info_hooks");
    }

    #[test]
    fn hookdel_gets_dash_a_spec() {
        let call = build_call("vcs_info_hookdel");
        assert_eq!(call.len(), 4);
        assert_eq!(call[1], "-a[remove all occurrences, not just the first]");
    }

    #[test]
    fn hook_type_spec_joins_all_types_with_spaces() {
        let call = build_call("");
        let spec = call.iter().find(|s| s.starts_with(":hook type:")).unwrap();
        assert_eq!(
            spec,
            ":hook type:(gen-applied-string gen-hg-bookmark-string gen-mqguards-string \
             gen-unapplied-string no-vcs post-backend post-quilt pre-addon-quilt pre-get-data \
             set-branch-format set-hgrev-format set-message set-patch-format start-up)"
        );
    }
}