grit-lib 0.3.99

Core library for the grit Git implementation
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

//! Per-worktree ref name parsing and storage location (Git `parse_worktree_ref` / `files_ref_path`).

use std::borrow::Cow;
use std::path::{Path, PathBuf};

use crate::refs::common_dir;

/// How a ref name maps to on-disk storage across worktrees.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RefWorktreeType {
    /// `HEAD`, `refs/worktree/*`, `refs/bisect/*`, `refs/rewritten/*` in this checkout's git dir.
    Current,
    /// `main-worktree/HEAD` → common dir + bare name.
    Main,
    /// `worktrees/<id>/HEAD` → `common/worktrees/<id>/` + bare name.
    Other,
    /// Shared refs (`refs/heads/*`, …) in the common git directory.
    Shared,
}

/// `refs/worktree/*`, `refs/bisect/*`, and `refs/rewritten/*` are per-worktree.
#[must_use]
pub fn is_per_worktree_ref(refname: &str) -> bool {
    refname.starts_with("refs/worktree/")
        || refname.starts_with("refs/bisect/")
        || refname.starts_with("refs/rewritten/")
}

fn is_root_ref_syntax(refname: &str) -> bool {
    !refname.is_empty()
        && refname
            .chars()
            .all(|c| c.is_ascii_uppercase() || c == '-' || c == '_')
}

fn is_current_worktree_ref(refname: &str) -> bool {
    is_root_ref_syntax(refname) || is_per_worktree_ref(refname)
}

/// Parse `maybe_worktree_ref` like Git `parse_worktree_ref`.
///
/// Returns worktree kind, bare ref name for storage, and worktree id for `worktrees/<id>/…`.
#[must_use]
pub fn parse_worktree_ref(maybe: &str) -> (RefWorktreeType, Cow<'_, str>, Option<Cow<'_, str>>) {
    if let Some(rest) = maybe.strip_prefix("worktrees/") {
        if let Some((id, bare)) = rest.split_once('/') {
            if is_current_worktree_ref(bare) {
                return (
                    RefWorktreeType::Other,
                    Cow::Borrowed(bare),
                    Some(Cow::Borrowed(id)),
                );
            }
        }
        return (
            RefWorktreeType::Other,
            Cow::Borrowed(""),
            Some(Cow::Borrowed(rest)),
        );
    }

    if let Some(bare) = maybe.strip_prefix("main-worktree/") {
        if is_current_worktree_ref(bare) {
            return (RefWorktreeType::Main, Cow::Borrowed(bare), None);
        }
    }

    if is_current_worktree_ref(maybe) {
        return (RefWorktreeType::Current, Cow::Borrowed(maybe), None);
    }

    (RefWorktreeType::Shared, Cow::Borrowed(maybe), None)
}

/// Git directory and on-disk ref path for `refname` from the current process's linked checkout.
#[must_use]
pub fn resolve_ref_storage(git_dir: &Path, refname: &str) -> (PathBuf, String) {
    let common = common_dir(git_dir).unwrap_or_else(|| git_dir.to_path_buf());
    let (kind, bare, wt_id) = parse_worktree_ref(refname);
    match kind {
        RefWorktreeType::Main => (common, bare.into_owned()),
        RefWorktreeType::Other => {
            let id = wt_id.map(|c| c.into_owned()).unwrap_or_default();
            (common.join("worktrees").join(id), bare.into_owned())
        }
        RefWorktreeType::Current => (git_dir.to_path_buf(), refname.to_owned()),
        RefWorktreeType::Shared => (common, refname.to_owned()),
    }
}

/// Whether `refname` should appear in `for-each-ref` from a linked worktree.
#[must_use]
pub fn ref_visible_from_worktree(git_dir: &Path, refname: &str) -> bool {
    if !is_per_worktree_ref(refname) {
        return true;
    }
    let (store, stor_name) = resolve_ref_storage(git_dir, refname);
    store.join(&stor_name).is_file()
}

/// True when `git_dir` is a linked worktree administrative directory.
#[must_use]
pub fn is_linked_worktree_git_dir(git_dir: &Path) -> bool {
    common_dir(git_dir).is_some()
}

/// DWIM rules matching Git `ref_rev_parse_rules` (`refs.c`).
const DWIM_RULES: &[&str] = &[
    "{0}",
    "refs/{0}",
    "refs/tags/{0}",
    "refs/heads/{0}",
    "refs/remotes/{0}",
    "refs/remotes/{0}/HEAD",
];

/// Resolve `spec` using Git `ref_rev_parse_rules` / `expand_ref`.
///
/// Returns the number of matching rules and the OID from the first match.
pub fn resolve_ref_dwim<F>(mut resolve: F, spec: &str) -> (usize, Option<crate::objects::ObjectId>)
where
    F: FnMut(&str) -> Option<crate::objects::ObjectId>,
{
    let mut count = 0usize;
    let mut first = None;
    for rule in DWIM_RULES {
        let candidate = rule.replace("{0}", spec);
        if let Some(oid) = resolve(&candidate) {
            count += 1;
            if first.is_none() {
                first = Some(oid);
            }
        }
    }
    (count, first)
}