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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
use std::{
ffi::OsString,
path::{Path, PathBuf},
};
use bstr::{BStr, ByteSlice};
use gix_glob::search::{pattern, Pattern};
use crate::Search;
/// Describes a matching pattern within a search for ignored paths.
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
pub struct Match<'a> {
/// The glob pattern itself, like `/target/*`.
pub pattern: &'a gix_glob::Pattern,
/// The path to the source from which the pattern was loaded, or `None` if it was specified by other means.
pub source: Option<&'a Path>,
/// The kind of pattern this match represents.
pub kind: crate::Kind,
/// The line at which the pattern was found in its `source` file, or the occurrence in which it was provided.
pub sequence_number: usize,
}
/// An implementation of the [`Pattern`] trait for ignore patterns.
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Default)]
pub struct Ignore;
impl Pattern for Ignore {
type Value = crate::Kind;
fn bytes_to_patterns(bytes: &[u8], _source: &std::path::Path) -> Vec<pattern::Mapping<Self::Value>> {
crate::parse(bytes)
.map(|(pattern, line_number, kind)| pattern::Mapping {
pattern,
value: kind,
sequence_number: line_number,
})
.collect()
}
}
/// Instantiation of a search for ignore patterns.
impl Search {
/// Given `git_dir`, a `.git` repository, load static ignore patterns from `info/exclude`
/// and from `excludes_file` if it is provided.
/// Note that it's not considered an error if the provided `excludes_file` does not exist.
pub fn from_git_dir(git_dir: &Path, excludes_file: Option<PathBuf>, buf: &mut Vec<u8>) -> std::io::Result<Self> {
let mut group = Self::default();
let follow_symlinks = true;
// order matters! More important ones first.
group.patterns.extend(
excludes_file
.and_then(|file| pattern::List::<Ignore>::from_file(file, None, follow_symlinks, buf).transpose())
.transpose()?,
);
group.patterns.extend(pattern::List::<Ignore>::from_file(
git_dir.join("info").join("exclude"),
None,
follow_symlinks,
buf,
)?);
Ok(group)
}
/// Parse a list of ignore patterns, using slashes as path separators.
pub fn from_overrides(patterns: impl IntoIterator<Item = impl Into<OsString>>) -> Self {
Self::from_overrides_inner(&mut patterns.into_iter().map(Into::into))
}
fn from_overrides_inner(patterns: &mut dyn Iterator<Item = OsString>) -> Self {
Search {
patterns: vec![pattern::List {
patterns: patterns
.enumerate()
.filter_map(|(seq_id, pattern)| {
let pattern = gix_path::try_into_bstr(PathBuf::from(pattern)).ok()?;
crate::parse(pattern.as_ref())
.next()
.map(|(p, _seq_id, kind)| pattern::Mapping {
pattern: p,
value: kind,
sequence_number: seq_id + 1,
})
})
.collect(),
source: None,
base: None,
}],
}
}
}
/// Mutation
impl Search {
/// Add patterns as parsed from `bytes`, providing their `source` path and possibly their `root` path, the path they
/// are relative to. This also means that `source` is contained within `root` if `root` is provided.
pub fn add_patterns_buffer(&mut self, bytes: &[u8], source: impl Into<PathBuf>, root: Option<&Path>) {
self.patterns
.push(pattern::List::from_bytes(bytes, source.into(), root));
}
}
/// Return a match if a pattern matches `relative_path`, providing a pre-computed `basename_pos` which is the
/// starting position of the basename of `relative_path`. `is_dir` is true if `relative_path` is a directory.
/// `case` specifies whether cases should be folded during matching or not.
pub fn pattern_matching_relative_path<'a>(
list: &'a gix_glob::search::pattern::List<Ignore>,
relative_path: &BStr,
basename_pos: Option<usize>,
is_dir: Option<bool>,
case: gix_glob::pattern::Case,
) -> Option<Match<'a>> {
let (relative_path, basename_start_pos) =
list.strip_base_handle_recompute_basename_pos(relative_path, basename_pos, case)?;
list.patterns.iter().rev().find_map(
|pattern::Mapping {
pattern,
value: kind,
sequence_number,
}| {
pattern
.matches_repo_relative_path(
relative_path,
basename_start_pos,
is_dir,
case,
gix_glob::wildmatch::Mode::NO_MATCH_SLASH_LITERAL,
)
.then_some(Match {
pattern,
kind: *kind,
source: list.source.as_deref(),
sequence_number: *sequence_number,
})
},
)
}
/// Like [`pattern_matching_relative_path()`], but returns an index to the pattern
/// that matched `relative_path`, instead of the match itself.
pub fn pattern_idx_matching_relative_path(
list: &gix_glob::search::pattern::List<Ignore>,
relative_path: &BStr,
basename_pos: Option<usize>,
is_dir: Option<bool>,
case: gix_glob::pattern::Case,
) -> Option<usize> {
let (relative_path, basename_start_pos) =
list.strip_base_handle_recompute_basename_pos(relative_path, basename_pos, case)?;
list.patterns.iter().enumerate().rev().find_map(|(idx, pm)| {
pm.pattern
.matches_repo_relative_path(
relative_path,
basename_start_pos,
is_dir,
case,
gix_glob::wildmatch::Mode::NO_MATCH_SLASH_LITERAL,
)
.then_some(idx)
})
}
/// Matching of ignore patterns.
impl Search {
/// Match `relative_path` and return the first match if found.
/// `is_dir` is true if `relative_path` is a directory.
/// `case` specifies whether cases should be folded during matching or not.
pub fn pattern_matching_relative_path(
&self,
relative_path: &BStr,
is_dir: Option<bool>,
case: gix_glob::pattern::Case,
) -> Option<Match<'_>> {
let basename_pos = relative_path.rfind(b"/").map(|p| p + 1);
self.patterns
.iter()
.rev()
.find_map(|pl| pattern_matching_relative_path(pl, relative_path, basename_pos, is_dir, case))
}
}