zshrs 0.11.5

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

//! Ported subsystems — every submodule here is a faithful 1:1 port of
//! a corresponding upstream zsh C source file under `src/zsh/Src/`.
//!
//! Companion / opposite of `src/extensions/`. See `docs/PORT.md` for the
//! full ruleset. `tests/port_purity.rs` enforces:
//!   - Every `.rs` file under this directory has a matching `.c` file
//!     under `src/zsh/Src/` (byte-for-byte identical stem).
//!   - Every top-level `fn` carries a doc comment matching the PORT.md
//!     template: `/// Port of NAME() from Src/STEM.c:NNNN`.
//!   - No file may carry the `WARNING: THIS IS ADHOC IMPLEMENTATION`
//!     marker.
//!
//! The crate root re-exports every submodule (`pub use ported::*;` in
//! `src/lib.rs`) so historical call sites that reference
//! `crate::exec::`, `crate::subst::`, `crate::zle::`, etc. continue
//! to resolve unchanged.

pub mod compat;
pub mod cond;
pub mod context;
// `exec` was moved to crate root (src/exec.rs) — it isn't a port of
// Src/exec.c (C zsh's wordcode VM; zshrs uses fusevm instead). Keep `crate::ported::exec` as a path alias so
// the many existing `crate::ported::exec::*` call-sites still work.
pub use crate::exec;
pub mod glob;
pub mod hashnameddir;
pub mod hashtable;
pub mod hashtable_h;
pub mod hist;
pub mod init;
pub mod input;
pub mod jobs;
pub mod linklist;
pub mod r#loop;
pub mod math;
pub mod mem;
pub mod modentry;
pub mod module;
pub mod modules;
pub mod openssh_bsd_setres_id;
pub mod options;
pub mod params;
pub mod pattern;
pub mod prompt;
pub mod signals;
pub mod sort;
pub mod string;
pub mod subst;
pub mod text;
pub mod utils;

pub mod builtin;
pub mod builtins;
pub mod zle;
pub mod zsh_h;
pub mod zsh_system_h;
pub mod ztype_h;
mod prototypes_h;
pub mod patchlevel;
pub mod signals_h;
pub mod config_h;
pub mod lex;
pub mod parse;

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

    /// The crate's `META` byte (0x83) is the metacharacter sentinel
    /// embedded in every metafied buffer. Three independent modules
    /// re-declare it (input.rs:472, utils.rs:4747, zsh_h.rs); the
    /// invariant is that the THREE constants are EQUAL. If anything
    /// drifts, lex/quote/unmeta semantics fracture across the codebase.
    #[test]
    fn meta_sentinel_consistent_across_modules() {
        assert_eq!(input::META as u8, zsh_h::META as u8);
        assert_eq!(utils::Meta,        zsh_h::META as u8);
        assert_eq!(input::META as u8, 0x83);
    }
}