diff --git a/rust/hg-core/src/lib.rs b/rust/hg-core/src/lib.rs --- a/rust/hg-core/src/lib.rs +++ b/rust/hg-core/src/lib.rs @@ -17,6 +17,7 @@ StateMap, StateMapIter, }; mod filepatterns; +pub mod matchers; pub mod utils; use crate::utils::hg_path::HgPathBuf; diff --git a/rust/hg-core/src/matchers.rs b/rust/hg-core/src/matchers.rs new file mode 100644 --- /dev/null +++ b/rust/hg-core/src/matchers.rs @@ -0,0 +1,105 @@ +// matchers.rs +// +// Copyright 2019 Raphaël Gomès +// +// This software may be used and distributed according to the terms of the +// GNU General Public License version 2 or any later version. + +//! Structs and types for matching files and directories. + +use crate::utils::hg_path::{HgPath, HgPathBuf}; +use std::collections::HashSet; + +pub enum VisitChildrenSet { + /// Don't visit anything + Empty, + /// Only visit this directory + This, + /// Visit this directory and these subdirectories + /// TODO Should we implement a `NonEmptyHashSet`? + Set(HashSet), + /// Visit this directory and all subdirectories + Recursive, +} + +pub trait Matcher { + /// Explicitly listed files + fn file_set(&self) -> HashSet<&HgPath>; + /// Returns whether `filename` is in `file_set` + fn exact_match(&self, _filename: impl AsRef) -> bool { + false + } + /// Returns whether `filename` is matched by this matcher + fn matches(&self, _filename: impl AsRef) -> bool { + false + } + /// Decides whether a directory should be visited based on whether it + /// has potential matches in it or one of its subdirectories, and + /// potentially lists which subdirectories of that directory should be + /// visited. This is based on the match's primary, included, and excluded + /// patterns. + /// + /// # Example + /// + /// Assume matchers `['path:foo/bar', 'rootfilesin:qux']`, we would + /// return the following values (assuming the implementation of + /// visit_children_set is capable of recognizing this; some implementations + /// are not). + /// + /// ```ignore + /// '' -> {'foo', 'qux'} + /// 'baz' -> set() + /// 'foo' -> {'bar'} + /// // Ideally this would be `Recursive`, but since the prefix nature of + /// // matchers is applied to the entire matcher, we have to downgrade this + /// // to `This` due to the (yet to be implemented in Rust) non-prefix + /// // `RootFilesIn'-kind matcher being mixed in. + /// 'foo/bar' -> 'this' + /// 'qux' -> 'this' + /// ``` + /// # Important + /// + /// Most matchers do not know if they're representing files or + /// directories. They see `['path:dir/f']` and don't know whether `f` is a + /// file or a directory, so `visit_children_set('dir')` for most matchers + /// will return `HashSet{ HgPath { "f" } }`, but if the matcher knows it's + /// a file (like the yet to be implemented in Rust `ExactMatcher` does), + /// it may return `VisitChildrenSet::This`. + /// Do not rely on the return being a `HashSet` indicating that there are + /// no files in this dir to investigate (or equivalently that if there are + /// files to investigate in 'dir' that it will always return + /// `VisitChildrenSet::This`). + fn visit_children_set( + &self, + _directory: impl AsRef, + ) -> VisitChildrenSet { + VisitChildrenSet::This + } + /// Matcher will match everything and `files_set()` will be empty: + /// optimization might be possible. + fn matches_everything(&self) -> bool { + false + } + /// Matcher will match exactly the files in `files_set()`: optimization + /// might be possible. + fn is_exact(&self) -> bool { + false + } +} + +/// Matches everything. +#[derive(Debug)] +pub struct AlwaysMatcher; + +impl Matcher for AlwaysMatcher { + fn file_set(&self) -> HashSet<&HgPath> { + HashSet::new() + } + + fn visit_children_set( + &self, + _directory: impl AsRef, + ) -> VisitChildrenSet { + VisitChildrenSet::Recursive + } +}