crates/oxy-core/src/repo/prompt.rs at d0990c2bff74 · andymccall/oxygen

# d0990c2bff74 oxygen / crates / oxy-core / src / repo / prompt.rs

22.5 KiB · Rust · last changed A command parses the manifest once 1 month ago source blame history raw

//! Fast, side-effect-free status for shell prompts.
//!
//! Every snapshot and checkout writes a manifest of the working copy as it
//! was last seen: `size`, `mtime`, and BLAKE3 of each file. `quick_status`
//! walks the working copy and compares against that manifest, reading a
//! file's content only when its size or mtime changed, and records no
//! operation. Ahead/behind counts come from walking the store between the
//! local bookmark and its `origin` tracking state.

use super::*;
use std::time::UNIX_EPOCH;

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PromptInfo {
    pub bookmark: String,
    /// Working-copy ChangeId prefix.
    pub change_id: String,
    pub heads: usize,
    pub dirty: bool,
    pub conflicted: bool,
    /// Changes local `main` has that `origin/main` lacks, when tracking exists.
    pub ahead: Option<usize>,
    pub behind: Option<usize>,
}

impl PromptInfo {
    /// The glyph for the working copy's state: `‼` conflicted, `✎` dirty,
    /// `✔` clean.
    pub fn state_glyph(&self) -> &'static str {
        if self.conflicted {
            "‼"
        } else if self.dirty {
            "✎"
        } else {
            "✔"
        }
    }

    /// The ANSI colour (SGR parameter) for the state: red, yellow, or cyan.
    pub fn state_color(&self) -> u8 {
        if self.conflicted {
            31
        } else if self.dirty {
            33
        } else {
            36
        }
    }

    /// `format` wrapped in the state colour. `guard` is `("\\[", "\\]")` for
    /// bash prompts, `("%{", "%}")` for zsh, or empty for raw output.
    pub fn format_colored(&self, fmt: &str, guard: (&str, &str)) -> String {
        format!(
            "{}\x1b[{}m{}{}{}\x1b[0m{}",
            guard.0,
            self.state_color(),
            guard.1,
            self.format(fmt),
            guard.0,
            guard.1
        )
    }

    /// Expand `%b` bookmark, `%c` change id, `%h` heads, `%d` dirty marker
    /// (`*`), `%x` conflict marker (`!`), `%a`/`%B` ahead/behind counts
    /// (empty when unknown), `%A`/`%D` `+n`/`-n` when non-zero, `%s` the
    /// state glyph, `%U`/`%O` `↑n`/`↓n` when non-zero, `%i` the repository
    /// icon, `%%` percent.
    pub fn format(&self, fmt: &str) -> String {
        let mut out = String::new();
        let mut chars = fmt.chars();
        while let Some(c) = chars.next() {
            if c != '%' {
                out.push(c);
                continue;
            }
            match chars.next() {
                Some('b') => out.push_str(&self.bookmark),
                Some('c') => out.push_str(&self.change_id),
                Some('h') => out.push_str(&self.heads.to_string()),
                Some('d') => {
                    if self.dirty {
                        out.push('*');
                    }
                }
                Some('x') => {
                    if self.conflicted {
                        out.push('!');
                    }
                }
                Some('a') => out.push_str(&self.ahead.map(|n| n.to_string()).unwrap_or_default()),
                Some('B') => out.push_str(&self.behind.map(|n| n.to_string()).unwrap_or_default()),
                Some('A') => {
                    if let Some(n) = self.ahead.filter(|n| *n > 0) {
                        out.push_str(&format!("+{n}"));
                    }
                }
                Some('D') => {
                    if let Some(n) = self.behind.filter(|n| *n > 0) {
                        out.push_str(&format!("-{n}"));
                    }
                }
                Some('s') => out.push_str(self.state_glyph()),
                Some('U') => {
                    if let Some(n) = self.ahead.filter(|n| *n > 0) {
                        out.push_str(&format!("↑{n}"));
                    }
                }
                Some('O') => {
                    if let Some(n) = self.behind.filter(|n| *n > 0) {
                        out.push_str(&format!("↓{n}"));
                    }
                }
                Some('i') => out.push_str(ICON),
                Some('%') => out.push('%'),
                Some(other) => {
                    out.push('%');
                    out.push(other);
                }
                None => out.push('%'),
            }
        }
        out
    }
}

/// Path → (size, mtime in nanoseconds, BLAKE3 hex) as last seen.
/// One manifest entry: the file's stat, its content hash, and the stored
/// blob for an opaque file.
#[derive(Clone, Debug)]
pub(crate) struct ManifestEntry {
    pub size: u64,
    pub mtime_ns: u128,
    pub hash: String,
    pub blob: Option<ObjectRef>,
    /// The graph key (`State::graph_key`) of the base file this text file
    /// was found equal to, rendered, byte for byte.
    pub graph: Option<String>,
    /// Whether the file was executable: a mode change alters neither size
    /// nor time.
    pub exec: bool,
}

#[derive(Clone, Debug, Default)]
pub(crate) struct Manifest {
    /// When the manifest was written, for the racy-stat guard.
    pub written_ns: u128,
    pub entries: BTreeMap<String, ManifestEntry>,
}

/// A parsed manifest and the identity (size, time, inode) of the file it
/// came from: reused while the file is the same one.
pub(crate) type CachedManifest = ((u64, u128, u64), (bool, bool, std::sync::Arc<Manifest>));

pub(crate) fn mtime_ns(m: &fs::Metadata) -> u128 {
    m.modified()
        .ok()
        .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
        .map(|d| d.as_nanos())
        .unwrap_or(0)
}

pub const DEFAULT_PROMPT_FORMAT: &str = "%b %c%d%x%A%D";
/// The repository icon for `%i` (an atom, for oxygen).
pub const ICON: &str = "⚛";
/// A format with glyphs: icon, bookmark, change id, state, ahead/behind.
pub const GLYPH_PROMPT_FORMAT: &str = "%i %b %c %s%U%O";

/// One manifest line per file: size, mtime in nanoseconds, hash, blob ref
/// or `-`, graph key or `-`, `x` when executable or `-`, path.
fn manifest_line(
    path: &str,
    size: u64,
    mtime_ns: u128,
    hash: &str,
    blob: Option<ObjectRef>,
    graph: Option<&str>,
    exec: bool,
) -> String {
    format!(
        "{size}\t{mtime_ns}\t{hash}\t{}\t{}\t{}\t{path}\n",
        blob.map(|b| b.to_hex()).unwrap_or_else(|| "-".into()),
        graph.unwrap_or("-"),
        if exec { "x" } else { "-" }
    )
}

impl Repo {
    pub(crate) fn manifest_path(&self) -> PathBuf {
        self.oxy
            .join("workspaces")
            .join(self.workspace.to_hex())
            .join("manifest")
    }

    /// Record the working copy as it is now (after a snapshot, commit, or
    /// checkout), with header lines saying whether the base state is
    /// conflicted and whether the working-copy change holds uncommitted work.
    pub(crate) fn write_manifest(&self, conflicted: bool, uncommitted: bool) -> Result<()> {
        let entries = self.walk_working_copy()?;
        self.write_manifest_entries(conflicted, uncommitted, &entries, &HashMap::new())
    }

    /// Write the manifest from entries already walked; `blobs` names the
    /// stored blob of each opaque path so the next walk can skip reading it.
    pub(crate) fn write_manifest_entries(
        &self,
        conflicted: bool,
        uncommitted: bool,
        entries: &BTreeMap<String, FsEntry>,
        blobs: &HashMap<String, ObjectRef>,
    ) -> Result<()> {
        self.manifest_cache.take();
        let written = std::time::SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .map(|d| d.as_nanos())
            .unwrap_or(0);
        let head = format!(
            "# conflicted={}\n# uncommitted={}\n",
            conflicted as u8, uncommitted as u8
        );
        let mut body = String::new();
        let mut newest_ns: u128 = 0;
        for (path, e) in entries {
            let full = self.root.join(path);
            let (size, mtime_ns) = match fs::symlink_metadata(&full) {
                Ok(m) => (m.len(), mtime_ns(&m)),
                Err(_) => (e.content.len() as u64, 0),
            };
            let hash = match &e.content_hash {
                Some(h) => h.clone(),
                None => blake3::hash(&e.content).to_hex().to_string(),
            };
            let blob = blobs.get(path).copied().or(e.blob);
            newest_ns = newest_ns.max(mtime_ns);
            body.push_str(&manifest_line(
                path,
                size,
                mtime_ns,
                &hash,
                blob,
                e.graph_key.as_deref(),
                e.exec,
            ));
        }
        let p = self.manifest_path();
        // Leave an unchanged manifest alone when its stamp already trusts
        // every entry (none is within the racy window): rewriting it would
        // change nothing but the file, which editors watching the tree
        // (and subrepos inside it) take as a change.
        if let Ok(old) = fs::read_to_string(&p) {
            let old_written: Option<u128> = old.lines().find_map(|l| {
                l.strip_prefix("# written=")
                    .and_then(|v| v.trim().parse().ok())
            });
            let old_rest: String = old
                .lines()
                .filter(|l| !l.starts_with("# written="))
                .map(|l| format!("{l}\n"))
                .collect();
            if let Some(w) = old_written {
                if old_rest == format!("{head}{body}") && newest_ns + 2_000_000_000 < w {
                    return Ok(());
                }
            }
        }
        let text = format!("{head}# written={written}\n{body}");
        fs::create_dir_all(p.parent().unwrap())?;
        write_atomic(&p, text.as_bytes())
    }

    /// Change the header flags, and set the graph key of each path in
    /// `keys` (after a commit, the new base's keys of the files it holds as
    /// they are on disk).
    pub(crate) fn rewrite_manifest(
        &self,
        conflicted: bool,
        uncommitted: bool,
        keys: &HashMap<String, String>,
    ) -> Result<()> {
        self.manifest_cache.take();
        let p = self.manifest_path();
        let text = match fs::read_to_string(&p) {
            Ok(t) => t,
            Err(_) => return self.write_manifest(conflicted, uncommitted),
        };
        let mut out = String::with_capacity(text.len());
        for line in text.lines() {
            if line.starts_with("# conflicted=") {
                out.push_str(&format!("# conflicted={}\n", conflicted as u8));
            } else if line.starts_with("# uncommitted=") {
                out.push_str(&format!("# uncommitted={}\n", uncommitted as u8));
            } else {
                let f: Vec<&str> = line.splitn(7, '\t').collect();
                match (f.len() == 7).then(|| keys.get(f[6])).flatten() {
                    Some(k) => out.push_str(&format!(
                        "{}\t{}\t{}\t{}\t{k}\t{}\t{}\n",
                        f[0], f[1], f[2], f[3], f[5], f[6]
                    )),
                    None => {
                        out.push_str(line);
                        out.push('\n');
                    }
                }
            }
        }
        write_atomic(&p, out.as_bytes())
    }

    /// Forget the manifest after an operation that changed the working-copy
    /// change without a snapshot (undo, rewrites); the prompt shows blank
    /// markers until the next snapshot.
    pub(crate) fn drop_manifest(&self) {
        self.manifest_cache.take();
        let _ = fs::remove_file(self.manifest_path());
    }

    /// The manifest, with whether it records a conflict and uncommitted
    /// work; parsed once while the file stays the same one.
    pub(crate) fn read_manifest(&self) -> Result<Option<(bool, bool, std::sync::Arc<Manifest>)>> {
        let path = self.manifest_path();
        let id = match fs::metadata(&path) {
            Ok(m) => {
                #[cfg(unix)]
                let ino = std::os::unix::fs::MetadataExt::ino(&m);
                #[cfg(not(unix))]
                let ino = 0;
                (m.len(), mtime_ns(&m), ino)
            }
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
            Err(e) => return Err(e.into()),
        };
        if let Some((cached_id, m)) = &*self.manifest_cache.borrow() {
            if *cached_id == id {
                return Ok(Some(m.clone()));
            }
        }
        let Some((c, u, m)) = self.parse_manifest(&path)? else {
            return Ok(None);
        };
        let m = (c, u, std::sync::Arc::new(m));
        *self.manifest_cache.borrow_mut() = Some((id, m.clone()));
        Ok(Some(m))
    }

    fn parse_manifest(&self, path: &std::path::Path) -> Result<Option<(bool, bool, Manifest)>> {
        let text = match fs::read_to_string(path) {
            Ok(t) => t,
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
            Err(e) => return Err(e.into()),
        };
        let mut out = Manifest::default();
        let mut conflicted = false;
        let mut uncommitted = false;
        for line in text.lines() {
            if let Some(v) = line.strip_prefix("# conflicted=") {
                conflicted = v.trim() == "1";
                continue;
            }
            if let Some(v) = line.strip_prefix("# uncommitted=") {
                uncommitted = v.trim() == "1";
                continue;
            }
            if let Some(v) = line.strip_prefix("# written=") {
                out.written_ns = v.trim().parse().unwrap_or(u128::MAX);
                continue;
            }
            // A line of another shape (an older manifest) is no entry: the
            // file is then read, and the next snapshot rewrites the line.
            let f: Vec<&str> = line.splitn(7, '\t').collect();
            if f.len() == 7 {
                out.entries.insert(
                    f[6].to_string(),
                    ManifestEntry {
                        size: f[0].parse().unwrap_or(0),
                        mtime_ns: f[1].parse().unwrap_or(0),
                        hash: f[2].to_string(),
                        blob: ObjectRef::from_hex(f[3]),
                        graph: (f[4] != "-").then(|| f[4].to_string()),
                        exec: f[5] == "x",
                    },
                );
            }
        }
        Ok(Some((conflicted, uncommitted, out)))
    }

    /// Whether the working copy is certainly clean, known from the manifest
    /// alone, without loading any history (spec §12.4): the last snapshot
    /// or commit found no uncommitted work and no conflict, every entry is
    /// older than the racy window (so an equal size and time mean equal
    /// content), there are no subrepos (whose state the manifest does not
    /// hold), and no file was added, removed or changed since. `false`
    /// means only that a snapshot must decide.
    pub fn clean_by_manifest(&self) -> Result<bool> {
        let _t = crate::timing::phase("status: check the manifest");
        let Some((conflicted, uncommitted, m)) = self.read_manifest()? else {
            return Ok(false);
        };
        if conflicted || uncommitted || self.root.join(".oxymodules").exists() {
            return Ok(false);
        }
        let racy = m
            .entries
            .values()
            .any(|e| e.mtime_ns + 2_000_000_000 >= m.written_ns);
        if racy {
            return Ok(false);
        }
        Ok(self.quick_dirty()? == Some(false))
    }

    /// Whether the working copy differs from the last manifest. Without a
    /// manifest the answer is `None`.
    pub fn quick_dirty(&self) -> Result<Option<bool>> {
        let Some((_, uncommitted, manifest)) = self.read_manifest()? else {
            return Ok(None);
        };
        if uncommitted {
            return Ok(Some(true));
        }
        use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering::Relaxed};
        let nested = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
        let wb = self.walker(&nested);
        // Every file is checked on its own, so the walk runs in parallel and
        // stops at the first difference.
        let dirty = AtomicBool::new(false);
        let seen = AtomicUsize::new(0);
        let (root, sparse) = (&self.root, &self.config.sparse_paths);
        let in_scope = |p: &str| {
            sparse.is_empty()
                || sparse
                    .iter()
                    .any(|s| p == s || p.starts_with(&format!("{s}/")))
        };
        wb.build_parallel().run(|| {
            Box::new(|entry| {
                use ignore::WalkState;
                if dirty.load(Relaxed) {
                    return WalkState::Quit;
                }
                let Ok(entry) = entry else {
                    return WalkState::Continue;
                };
                let Some(ft) = entry.file_type() else {
                    return WalkState::Continue;
                };
                if ft.is_dir() {
                    return WalkState::Continue;
                }
                let under = entry.path().strip_prefix(root).unwrap();
                let rel: String = match under.to_str() {
                    Some(s) if std::path::MAIN_SEPARATOR == '/' => s.to_string(),
                    _ => under
                        .components()
                        .map(|c| c.as_os_str().to_string_lossy().to_string())
                        .collect::<Vec<_>>()
                        .join("/"),
                };
                if !in_scope(&rel) {
                    return WalkState::Continue;
                }
                // Whether this file differs from its entry; an unreadable
                // one counts as different.
                let differs = match manifest.entries.get(&rel) {
                    None => true,
                    Some(me) => {
                        seen.fetch_add(1, Relaxed);
                        match fs::symlink_metadata(entry.path()) {
                            Err(_) => true,
                            Ok(_) if ft.is_symlink() => {
                                !fs::read_link(entry.path()).is_ok_and(|t| {
                                    blake3::hash(t.to_string_lossy().as_bytes())
                                        .to_hex()
                                        .as_str()
                                        == me.hash
                                })
                            }
                            Ok(m) => {
                                m.len() != me.size
                                    || super::is_executable(&m) != me.exec
                                    || (mtime_ns(&m) != me.mtime_ns
                                        && !fs::read(entry.path()).is_ok_and(|b| {
                                            blake3::hash(&b).to_hex().as_str() == me.hash
                                        }))
                            }
                        }
                    }
                };
                if differs {
                    dirty.store(true, Relaxed);
                    return WalkState::Quit;
                }
                WalkState::Continue
            })
        });
        if dirty.load(Relaxed) {
            return Ok(Some(true));
        }
        let seen = seen.load(Relaxed);
        if seen == manifest.entries.len() {
            return Ok(Some(false));
        }
        // Manifest entries the walk skipped: tracked files that ignore rules
        // hide. They count as present when still on disk and unchanged.
        for (rel, me) in &manifest.entries {
            let path = self.root.join(rel);
            let Ok(m) = fs::symlink_metadata(&path) else {
                return Ok(Some(true));
            };
            if m.file_type().is_symlink() {
                continue;
            }
            if m.len() != me.size
                || super::is_executable(&m) != me.exec
                || (mtime_ns(&m) != me.mtime_ns
                    && blake3::hash(&fs::read(&path)?).to_hex().as_str() != me.hash)
            {
                return Ok(Some(true));
            }
        }
        Ok(Some(false))
    }

    /// Prompt information without recording anything.
    pub fn quick_status(&self) -> Result<PromptInfo> {
        let view = self.view()?;
        let bookmark = self.config.bookmark.clone();
        let heads = self.heads_of(&view, &bookmark)?;
        let wc_hash = view.workspaces.get(&self.workspace).copied();
        let change_id = match wc_hash {
            Some(h) => self.store.get_change_meta(&h)?.change_id.short(8),
            None => String::new(),
        };
        // Conflictedness was recorded by the last snapshot; without a
        // manifest (never snapshotted) both flags are unknown and shown clear.
        let manifest = self.read_manifest()?;
        let conflicted = manifest.as_ref().map(|(c, _, _)| *c).unwrap_or(false);
        let dirty = self.quick_dirty()?.unwrap_or(false);
        let (ahead, behind) = match view.remotes.get("origin").and_then(|b| b.get(&bookmark)) {
            Some(st) => {
                let remote_heads = self.store.get_state(st)?.heads;
                let ahead = self.negotiate(&remote_heads, &heads).map(|v| v.len()).ok();
                let behind = self.negotiate(&heads, &remote_heads).map(|v| v.len()).ok();
                (ahead, behind)
            }
            None => (None, None),
        };
        Ok(PromptInfo {
            bookmark,
            change_id,
            heads: heads.len(),
            dirty,
            conflicted,
            ahead,
            behind,
        })
    }
}

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

    #[test]
    fn placeholders_and_glyphs() {
        let clean = PromptInfo {
            bookmark: "main".into(),
            change_id: "658990aa".into(),
            heads: 1,
            dirty: false,
            conflicted: false,
            ahead: Some(0),
            behind: None,
        };
        assert_eq!(clean.format(DEFAULT_PROMPT_FORMAT), "main 658990aa");
        assert_eq!(clean.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✔");
        let busy = PromptInfo {
            dirty: true,
            ahead: Some(2),
            behind: Some(3),
            ..clean.clone()
        };
        assert_eq!(busy.format(DEFAULT_PROMPT_FORMAT), "main 658990aa*+2-3");
        assert_eq!(busy.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✎↑2↓3");
        let bad = PromptInfo {
            conflicted: true,
            ..busy.clone()
        };
        assert_eq!(bad.format("%s%x%d %h %a/%B %%"), "‼!* 1 2/3 %");
        assert_eq!(bad.state_color(), 31);
        assert_eq!(
            busy.format_colored("%b", ("\\[", "\\]")),
            "\\[\x1b[33m\\]main\\[\x1b[0m\\]"
        );
        assert_eq!(clean.format_colored("%b", ("", "")), "\x1b[36mmain\x1b[0m");
        assert_eq!(clean.format("%q"), "%q");
    }
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1	//! Fast, side-effect-free status for shell prompts.
2	//!
3	//! Every snapshot and checkout writes a manifest of the working copy as it
4	//! was last seen: `size`, `mtime`, and BLAKE3 of each file. `quick_status`
5	//! walks the working copy and compares against that manifest, reading a
6	//! file's content only when its size or mtime changed, and records no
7	//! operation. Ahead/behind counts come from walking the store between the
8	//! local bookmark and its `origin` tracking state.
9
10	use super::*;
11	use std::time::UNIX_EPOCH;
12
13	#[derive(Debug, Clone, Default, PartialEq, Eq)]
14	pub struct PromptInfo {
15	pub bookmark: String,
16	/// Working-copy ChangeId prefix.
17	pub change_id: String,
18	pub heads: usize,
19	pub dirty: bool,
20	pub conflicted: bool,
21	/// Changes local `main` has that `origin/main` lacks, when tracking exists.
22	pub ahead: Option<usize>,
23	pub behind: Option<usize>,
24	}
25
26	impl PromptInfo {
27	/// The glyph for the working copy's state: `‼` conflicted, `✎` dirty,
28	/// `✔` clean.
29	pub fn state_glyph(&self) -> &'static str {
30	if self.conflicted {
31	"‼"
32	} else if self.dirty {
33	"✎"
34	} else {
35	"✔"
36	}
37	}
38
39	/// The ANSI colour (SGR parameter) for the state: red, yellow, or cyan.
40	pub fn state_color(&self) -> u8 {
41	if self.conflicted {
42	31
43	} else if self.dirty {
44	33
45	} else {
46	36
47	}
48	}
49
50	/// `format` wrapped in the state colour. `guard` is `("\\[", "\\]")` for
51	/// bash prompts, `("%{", "%}")` for zsh, or empty for raw output.
52	pub fn format_colored(&self, fmt: &str, guard: (&str, &str)) -> String {
53	format!(
54	"{}\x1b[{}m{}{}{}\x1b[0m{}",
55	guard.0,
56	self.state_color(),
57	guard.1,
58	self.format(fmt),
59	guard.0,
60	guard.1
61	)
62	}
63
64	/// Expand `%b` bookmark, `%c` change id, `%h` heads, `%d` dirty marker
65	/// (`*`), `%x` conflict marker (`!`), `%a`/`%B` ahead/behind counts
66	/// (empty when unknown), `%A`/`%D` `+n`/`-n` when non-zero, `%s` the
67	/// state glyph, `%U`/`%O` `↑n`/`↓n` when non-zero, `%i` the repository
68	/// icon, `%%` percent.
69	pub fn format(&self, fmt: &str) -> String {
70	let mut out = String::new();
71	let mut chars = fmt.chars();
72	while let Some(c) = chars.next() {
73	if c != '%' {
74	out.push(c);
75	continue;
76	}
77	match chars.next() {
78	Some('b') => out.push_str(&self.bookmark),
79	Some('c') => out.push_str(&self.change_id),
80	Some('h') => out.push_str(&self.heads.to_string()),
81	Some('d') => {
82	if self.dirty {
83	out.push('*');
84	}
85	}
86	Some('x') => {
87	if self.conflicted {
88	out.push('!');
89	}
90	}
91	Some('a') => out.push_str(&self.ahead.map(\|n\| n.to_string()).unwrap_or_default()),
92	Some('B') => out.push_str(&self.behind.map(\|n\| n.to_string()).unwrap_or_default()),
93	Some('A') => {
94	if let Some(n) = self.ahead.filter(\|n\| *n > 0) {
95	out.push_str(&format!("+{n}"));
96	}
97	}
98	Some('D') => {
99	if let Some(n) = self.behind.filter(\|n\| *n > 0) {
100	out.push_str(&format!("-{n}"));
101	}
102	}
103	Some('s') => out.push_str(self.state_glyph()),
104	Some('U') => {
105	if let Some(n) = self.ahead.filter(\|n\| *n > 0) {
106	out.push_str(&format!("↑{n}"));
107	}
108	}
109	Some('O') => {
110	if let Some(n) = self.behind.filter(\|n\| *n > 0) {
111	out.push_str(&format!("↓{n}"));
112	}
113	}
114	Some('i') => out.push_str(ICON),
115	Some('%') => out.push('%'),
116	Some(other) => {
117	out.push('%');
118	out.push(other);
119	}
120	None => out.push('%'),
121	}
122	}
123	out
124	}
125	}
126
127	/// Path → (size, mtime in nanoseconds, BLAKE3 hex) as last seen.
128	/// One manifest entry: the file's stat, its content hash, and the stored
129	/// blob for an opaque file.
130	#[derive(Clone, Debug)]
131	pub(crate) struct ManifestEntry {
132	pub size: u64,
133	pub mtime_ns: u128,
134	pub hash: String,
135	pub blob: Option<ObjectRef>,
136	/// The graph key (`State::graph_key`) of the base file this text file
137	/// was found equal to, rendered, byte for byte.
138	pub graph: Option<String>,
139	/// Whether the file was executable: a mode change alters neither size
140	/// nor time.
141	pub exec: bool,
142	}
143
144	#[derive(Clone, Debug, Default)]
145	pub(crate) struct Manifest {
146	/// When the manifest was written, for the racy-stat guard.
147	pub written_ns: u128,
148	pub entries: BTreeMap<String, ManifestEntry>,
149	}
150
151	/// A parsed manifest and the identity (size, time, inode) of the file it
152	/// came from: reused while the file is the same one.
153	pub(crate) type CachedManifest = ((u64, u128, u64), (bool, bool, std::sync::Arc<Manifest>));
154
155	pub(crate) fn mtime_ns(m: &fs::Metadata) -> u128 {
156	m.modified()
157	.ok()
158	.and_then(\|t\| t.duration_since(UNIX_EPOCH).ok())
159	.map(\|d\| d.as_nanos())
160	.unwrap_or(0)
161	}
162
163	pub const DEFAULT_PROMPT_FORMAT: &str = "%b %c%d%x%A%D";
164	/// The repository icon for `%i` (an atom, for oxygen).
165	pub const ICON: &str = "⚛";
166	/// A format with glyphs: icon, bookmark, change id, state, ahead/behind.
167	pub const GLYPH_PROMPT_FORMAT: &str = "%i %b %c %s%U%O";
168
169	/// One manifest line per file: size, mtime in nanoseconds, hash, blob ref
170	/// or `-`, graph key or `-`, `x` when executable or `-`, path.
171	fn manifest_line(
172	path: &str,
173	size: u64,
174	mtime_ns: u128,
175	hash: &str,
176	blob: Option<ObjectRef>,
177	graph: Option<&str>,
178	exec: bool,
179	) -> String {
180	format!(
181	"{size}\t{mtime_ns}\t{hash}\t{}\t{}\t{}\t{path}\n",
182	blob.map(\|b\| b.to_hex()).unwrap_or_else(\|\| "-".into()),
183	graph.unwrap_or("-"),
184	if exec { "x" } else { "-" }
185	)
186	}
187
188	impl Repo {
189	pub(crate) fn manifest_path(&self) -> PathBuf {
190	self.oxy
191	.join("workspaces")
192	.join(self.workspace.to_hex())
193	.join("manifest")
194	}
195
196	/// Record the working copy as it is now (after a snapshot, commit, or
197	/// checkout), with header lines saying whether the base state is
198	/// conflicted and whether the working-copy change holds uncommitted work.
199	pub(crate) fn write_manifest(&self, conflicted: bool, uncommitted: bool) -> Result<()> {
200	let entries = self.walk_working_copy()?;
201	self.write_manifest_entries(conflicted, uncommitted, &entries, &HashMap::new())
202	}
203
204	/// Write the manifest from entries already walked; `blobs` names the
205	/// stored blob of each opaque path so the next walk can skip reading it.
206	pub(crate) fn write_manifest_entries(
207	&self,
208	conflicted: bool,
209	uncommitted: bool,
210	entries: &BTreeMap<String, FsEntry>,
211	blobs: &HashMap<String, ObjectRef>,
212	) -> Result<()> {
213	self.manifest_cache.take();
214	let written = std::time::SystemTime::now()
215	.duration_since(UNIX_EPOCH)
216	.map(\|d\| d.as_nanos())
217	.unwrap_or(0);
218	let head = format!(
219	"# conflicted={}\n# uncommitted={}\n",
220	conflicted as u8, uncommitted as u8
221	);
222	let mut body = String::new();
223	let mut newest_ns: u128 = 0;
224	for (path, e) in entries {
225	let full = self.root.join(path);
226	let (size, mtime_ns) = match fs::symlink_metadata(&full) {
227	Ok(m) => (m.len(), mtime_ns(&m)),
228	Err(_) => (e.content.len() as u64, 0),
229	};
230	let hash = match &e.content_hash {
231	Some(h) => h.clone(),
232	None => blake3::hash(&e.content).to_hex().to_string(),
233	};
234	let blob = blobs.get(path).copied().or(e.blob);
235	newest_ns = newest_ns.max(mtime_ns);
236	body.push_str(&manifest_line(
237	path,
238	size,
239	mtime_ns,
240	&hash,
241	blob,
242	e.graph_key.as_deref(),
243	e.exec,
244	));
245	}
246	let p = self.manifest_path();
247	// Leave an unchanged manifest alone when its stamp already trusts
248	// every entry (none is within the racy window): rewriting it would
249	// change nothing but the file, which editors watching the tree
250	// (and subrepos inside it) take as a change.
251	if let Ok(old) = fs::read_to_string(&p) {
252	let old_written: Option<u128> = old.lines().find_map(\|l\| {
253	l.strip_prefix("# written=")
254	.and_then(\|v\| v.trim().parse().ok())
255	});
256	let old_rest: String = old
257	.lines()
258	.filter(\|l\| !l.starts_with("# written="))
259	.map(\|l\| format!("{l}\n"))
260	.collect();
261	if let Some(w) = old_written {
262	if old_rest == format!("{head}{body}") && newest_ns + 2_000_000_000 < w {
263	return Ok(());
264	}
265	}
266	}
267	let text = format!("{head}# written={written}\n{body}");
268	fs::create_dir_all(p.parent().unwrap())?;
269	write_atomic(&p, text.as_bytes())
270	}
271
272	/// Change the header flags, and set the graph key of each path in
273	/// `keys` (after a commit, the new base's keys of the files it holds as
274	/// they are on disk).
275	pub(crate) fn rewrite_manifest(
276	&self,
277	conflicted: bool,
278	uncommitted: bool,
279	keys: &HashMap<String, String>,
280	) -> Result<()> {
281	self.manifest_cache.take();
282	let p = self.manifest_path();
283	let text = match fs::read_to_string(&p) {
284	Ok(t) => t,
285	Err(_) => return self.write_manifest(conflicted, uncommitted),
286	};
287	let mut out = String::with_capacity(text.len());
288	for line in text.lines() {
289	if line.starts_with("# conflicted=") {
290	out.push_str(&format!("# conflicted={}\n", conflicted as u8));
291	} else if line.starts_with("# uncommitted=") {
292	out.push_str(&format!("# uncommitted={}\n", uncommitted as u8));
293	} else {
294	let f: Vec<&str> = line.splitn(7, '\t').collect();
295	match (f.len() == 7).then(\|\| keys.get(f[6])).flatten() {
296	Some(k) => out.push_str(&format!(
297	"{}\t{}\t{}\t{}\t{k}\t{}\t{}\n",
298	f[0], f[1], f[2], f[3], f[5], f[6]
299	)),
300	None => {
301	out.push_str(line);
302	out.push('\n');
303	}
304	}
305	}
306	}
307	write_atomic(&p, out.as_bytes())
308	}
309
310	/// Forget the manifest after an operation that changed the working-copy
311	/// change without a snapshot (undo, rewrites); the prompt shows blank
312	/// markers until the next snapshot.
313	pub(crate) fn drop_manifest(&self) {
314	self.manifest_cache.take();
315	let _ = fs::remove_file(self.manifest_path());
316	}
317
318	/// The manifest, with whether it records a conflict and uncommitted
319	/// work; parsed once while the file stays the same one.
320	pub(crate) fn read_manifest(&self) -> Result<Option<(bool, bool, std::sync::Arc<Manifest>)>> {
321	let path = self.manifest_path();
322	let id = match fs::metadata(&path) {
323	Ok(m) => {
324	#[cfg(unix)]
325	let ino = std::os::unix::fs::MetadataExt::ino(&m);
326	#[cfg(not(unix))]
327	let ino = 0;
328	(m.len(), mtime_ns(&m), ino)
329	}
330	Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
331	Err(e) => return Err(e.into()),
332	};
333	if let Some((cached_id, m)) = &*self.manifest_cache.borrow() {
334	if *cached_id == id {
335	return Ok(Some(m.clone()));
336	}
337	}
338	let Some((c, u, m)) = self.parse_manifest(&path)? else {
339	return Ok(None);
340	};
341	let m = (c, u, std::sync::Arc::new(m));
342	*self.manifest_cache.borrow_mut() = Some((id, m.clone()));
343	Ok(Some(m))
344	}
345
346	fn parse_manifest(&self, path: &std::path::Path) -> Result<Option<(bool, bool, Manifest)>> {
347	let text = match fs::read_to_string(path) {
348	Ok(t) => t,
349	Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
350	Err(e) => return Err(e.into()),
351	};
352	let mut out = Manifest::default();
353	let mut conflicted = false;
354	let mut uncommitted = false;
355	for line in text.lines() {
356	if let Some(v) = line.strip_prefix("# conflicted=") {
357	conflicted = v.trim() == "1";
358	continue;
359	}
360	if let Some(v) = line.strip_prefix("# uncommitted=") {
361	uncommitted = v.trim() == "1";
362	continue;
363	}
364	if let Some(v) = line.strip_prefix("# written=") {
365	out.written_ns = v.trim().parse().unwrap_or(u128::MAX);
366	continue;
367	}
368	// A line of another shape (an older manifest) is no entry: the
369	// file is then read, and the next snapshot rewrites the line.
370	let f: Vec<&str> = line.splitn(7, '\t').collect();
371	if f.len() == 7 {
372	out.entries.insert(
373	f[6].to_string(),
374	ManifestEntry {
375	size: f[0].parse().unwrap_or(0),
376	mtime_ns: f[1].parse().unwrap_or(0),
377	hash: f[2].to_string(),
378	blob: ObjectRef::from_hex(f[3]),
379	graph: (f[4] != "-").then(\|\| f[4].to_string()),
380	exec: f[5] == "x",
381	},
382	);
383	}
384	}
385	Ok(Some((conflicted, uncommitted, out)))
386	}
387
388	/// Whether the working copy is certainly clean, known from the manifest
389	/// alone, without loading any history (spec §12.4): the last snapshot
390	/// or commit found no uncommitted work and no conflict, every entry is
391	/// older than the racy window (so an equal size and time mean equal
392	/// content), there are no subrepos (whose state the manifest does not
393	/// hold), and no file was added, removed or changed since. `false`
394	/// means only that a snapshot must decide.
395	pub fn clean_by_manifest(&self) -> Result<bool> {
396	let _t = crate::timing::phase("status: check the manifest");
397	let Some((conflicted, uncommitted, m)) = self.read_manifest()? else {
398	return Ok(false);
399	};
400	if conflicted \|\| uncommitted \|\| self.root.join(".oxymodules").exists() {
401	return Ok(false);
402	}
403	let racy = m
404	.entries
405	.values()
406	.any(\|e\| e.mtime_ns + 2_000_000_000 >= m.written_ns);
407	if racy {
408	return Ok(false);
409	}
410	Ok(self.quick_dirty()? == Some(false))
411	}
412
413	/// Whether the working copy differs from the last manifest. Without a
414	/// manifest the answer is `None`.
415	pub fn quick_dirty(&self) -> Result<Option<bool>> {
416	let Some((_, uncommitted, manifest)) = self.read_manifest()? else {
417	return Ok(None);
418	};
419	if uncommitted {
420	return Ok(Some(true));
421	}
422	use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering::Relaxed};
423	let nested = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
424	let wb = self.walker(&nested);
425	// Every file is checked on its own, so the walk runs in parallel and
426	// stops at the first difference.
427	let dirty = AtomicBool::new(false);
428	let seen = AtomicUsize::new(0);
429	let (root, sparse) = (&self.root, &self.config.sparse_paths);
430	let in_scope = \|p: &str\| {
431	sparse.is_empty()
432	\|\| sparse
433	.iter()
434	.any(\|s\| p == s \|\| p.starts_with(&format!("{s}/")))
435	};
436	wb.build_parallel().run(\|\| {
437	Box::new(\|entry\| {
438	use ignore::WalkState;
439	if dirty.load(Relaxed) {
440	return WalkState::Quit;
441	}
442	let Ok(entry) = entry else {
443	return WalkState::Continue;
444	};
445	let Some(ft) = entry.file_type() else {
446	return WalkState::Continue;
447	};
448	if ft.is_dir() {
449	return WalkState::Continue;
450	}
451	let under = entry.path().strip_prefix(root).unwrap();
452	let rel: String = match under.to_str() {
453	Some(s) if std::path::MAIN_SEPARATOR == '/' => s.to_string(),
454	_ => under
455	.components()
456	.map(\|c\| c.as_os_str().to_string_lossy().to_string())
457	.collect::<Vec<_>>()
458	.join("/"),
459	};
460	if !in_scope(&rel) {
461	return WalkState::Continue;
462	}
463	// Whether this file differs from its entry; an unreadable
464	// one counts as different.
465	let differs = match manifest.entries.get(&rel) {
466	None => true,
467	Some(me) => {
468	seen.fetch_add(1, Relaxed);
469	match fs::symlink_metadata(entry.path()) {
470	Err(_) => true,
471	Ok(_) if ft.is_symlink() => {
472	!fs::read_link(entry.path()).is_ok_and(\|t\| {
473	blake3::hash(t.to_string_lossy().as_bytes())
474	.to_hex()
475	.as_str()
476	== me.hash
477	})
478	}
479	Ok(m) => {
480	m.len() != me.size
481	\|\| super::is_executable(&m) != me.exec
482	\|\| (mtime_ns(&m) != me.mtime_ns
483	&& !fs::read(entry.path()).is_ok_and(\|b\| {
484	blake3::hash(&b).to_hex().as_str() == me.hash
485	}))
486	}
487	}
488	}
489	};
490	if differs {
491	dirty.store(true, Relaxed);
492	return WalkState::Quit;
493	}
494	WalkState::Continue
495	})
496	});
497	if dirty.load(Relaxed) {
498	return Ok(Some(true));
499	}
500	let seen = seen.load(Relaxed);
501	if seen == manifest.entries.len() {
502	return Ok(Some(false));
503	}
504	// Manifest entries the walk skipped: tracked files that ignore rules
505	// hide. They count as present when still on disk and unchanged.
506	for (rel, me) in &manifest.entries {
507	let path = self.root.join(rel);
508	let Ok(m) = fs::symlink_metadata(&path) else {
509	return Ok(Some(true));
510	};
511	if m.file_type().is_symlink() {
512	continue;
513	}
514	if m.len() != me.size
515	\|\| super::is_executable(&m) != me.exec
516	\|\| (mtime_ns(&m) != me.mtime_ns
517	&& blake3::hash(&fs::read(&path)?).to_hex().as_str() != me.hash)
518	{
519	return Ok(Some(true));
520	}
521	}
522	Ok(Some(false))
523	}
524
525	/// Prompt information without recording anything.
526	pub fn quick_status(&self) -> Result<PromptInfo> {
527	let view = self.view()?;
528	let bookmark = self.config.bookmark.clone();
529	let heads = self.heads_of(&view, &bookmark)?;
530	let wc_hash = view.workspaces.get(&self.workspace).copied();
531	let change_id = match wc_hash {
532	Some(h) => self.store.get_change_meta(&h)?.change_id.short(8),
533	None => String::new(),
534	};
535	// Conflictedness was recorded by the last snapshot; without a
536	// manifest (never snapshotted) both flags are unknown and shown clear.
537	let manifest = self.read_manifest()?;
538	let conflicted = manifest.as_ref().map(\|(c, _, _)\| *c).unwrap_or(false);
539	let dirty = self.quick_dirty()?.unwrap_or(false);
540	let (ahead, behind) = match view.remotes.get("origin").and_then(\|b\| b.get(&bookmark)) {
541	Some(st) => {
542	let remote_heads = self.store.get_state(st)?.heads;
543	let ahead = self.negotiate(&remote_heads, &heads).map(\|v\| v.len()).ok();
544	let behind = self.negotiate(&heads, &remote_heads).map(\|v\| v.len()).ok();
545	(ahead, behind)
546	}
547	None => (None, None),
548	};
549	Ok(PromptInfo {
550	bookmark,
551	change_id,
552	heads: heads.len(),
553	dirty,
554	conflicted,
555	ahead,
556	behind,
557	})
558	}
559	}
560
561	#[cfg(test)]
562	mod tests {
563	use super::*;
564
565	#[test]
566	fn placeholders_and_glyphs() {
567	let clean = PromptInfo {
568	bookmark: "main".into(),
569	change_id: "658990aa".into(),
570	heads: 1,
571	dirty: false,
572	conflicted: false,
573	ahead: Some(0),
574	behind: None,
575	};
576	assert_eq!(clean.format(DEFAULT_PROMPT_FORMAT), "main 658990aa");
577	assert_eq!(clean.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✔");
578	let busy = PromptInfo {
579	dirty: true,
580	ahead: Some(2),
581	behind: Some(3),
582	..clean.clone()
583	};
584	assert_eq!(busy.format(DEFAULT_PROMPT_FORMAT), "main 658990aa*+2-3");
585	assert_eq!(busy.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✎↑2↓3");
586	let bad = PromptInfo {
587	conflicted: true,
588	..busy.clone()
589	};
590	assert_eq!(bad.format("%s%x%d %h %a/%B %%"), "‼!* 1 2/3 %");
591	assert_eq!(bad.state_color(), 31);
592	assert_eq!(
593	busy.format_colored("%b", ("\\[", "\\]")),
594	"\\[\x1b[33m\\]main\\[\x1b[0m\\]"
595	);
596	assert_eq!(clean.format_colored("%b", ("", "")), "\x1b[36mmain\x1b[0m");
597	assert_eq!(clean.format("%q"), "%q");
598	}
599	}

Keyboard