summaryrefslogtreecommitdiffstats
path: root/vendor/gix-attributes/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gix-attributes/src/lib.rs')
-rw-r--r--vendor/gix-attributes/src/lib.rs137
1 files changed, 137 insertions, 0 deletions
diff --git a/vendor/gix-attributes/src/lib.rs b/vendor/gix-attributes/src/lib.rs
new file mode 100644
index 000000000..7d95c022f
--- /dev/null
+++ b/vendor/gix-attributes/src/lib.rs
@@ -0,0 +1,137 @@
+//! Parse `.gitattribute` and `.gitignore` files and provide utilities to match against them.
+//!
+//! ## Feature Flags
+#![cfg_attr(
+ feature = "document-features",
+ cfg_attr(doc, doc = ::document_features::document_features!())
+)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms)]
+#![forbid(unsafe_code)]
+
+use std::path::PathBuf;
+
+use bstr::{BStr, BString};
+pub use gix_glob as glob;
+
+mod assignment;
+///
+pub mod name;
+mod state;
+
+mod match_group;
+pub use match_group::{Attributes, Ignore, Match, Pattern};
+
+///
+pub mod parse;
+/// Parse attribute assignments line by line from `bytes`.
+pub fn parse(bytes: &[u8]) -> parse::Lines<'_> {
+ parse::Lines::new(bytes)
+}
+
+/// The state an attribute can be in, referencing the value.
+///
+/// Note that this doesn't contain the name.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
+pub enum StateRef<'a> {
+ /// The attribute is listed, or has the special value 'true'
+ Set,
+ /// The attribute has the special value 'false', or was prefixed with a `-` sign.
+ Unset,
+ /// The attribute is set to the given value, which followed the `=` sign.
+ /// Note that values can be empty.
+ #[cfg_attr(feature = "serde1", serde(borrow))]
+ Value(&'a BStr),
+ /// The attribute isn't mentioned with a given path or is explicitly set to `Unspecified` using the `!` sign.
+ Unspecified,
+}
+
+/// The state an attribute can be in, owning the value.
+///
+/// Note that this doesn't contain the name.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
+#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
+pub enum State {
+ /// The attribute is listed, or has the special value 'true'
+ Set,
+ /// The attribute has the special value 'false', or was prefixed with a `-` sign.
+ Unset,
+ /// The attribute is set to the given value, which followed the `=` sign.
+ /// Note that values can be empty.
+ Value(BString), // TODO(performance): Is there a non-utf8 compact_str/KBString crate? See https://github.com/cobalt-org/kstring/issues/37#issuecomment-1446777265 .
+ /// The attribute isn't mentioned with a given path or is explicitly set to `Unspecified` using the `!` sign.
+ Unspecified,
+}
+
+/// Represents a validated attribute name
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
+#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
+pub struct Name(pub(crate) String); // TODO(performance): See if `KBString` or `compact_string` could be meaningful here.
+
+/// Holds a validated attribute name as a reference
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd)]
+pub struct NameRef<'a>(&'a str);
+
+/// Name an attribute and describe it's assigned state.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
+#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
+pub struct Assignment {
+ /// The validated name of the attribute.
+ pub name: Name,
+ /// The state of the attribute.
+ pub state: State,
+}
+
+/// Holds validated attribute data as a reference
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd)]
+pub struct AssignmentRef<'a> {
+ /// The name of the attribute.
+ pub name: NameRef<'a>,
+ /// The state of the attribute.
+ pub state: StateRef<'a>,
+}
+
+/// A grouping of lists of patterns while possibly keeping associated to their base path.
+///
+/// Pattern lists with base path are queryable relative to that base, otherwise they are relative to the repository root.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Default)]
+pub struct MatchGroup<T: Pattern = Attributes> {
+ /// A list of pattern lists, each representing a patterns from a file or specified by hand, in the order they were
+ /// specified in.
+ ///
+ /// During matching, this order is reversed.
+ pub patterns: Vec<PatternList<T>>,
+}
+
+/// A list of patterns which optionally know where they were loaded from and what their base is.
+///
+/// Knowing their base which is relative to a source directory, it will ignore all path to match against
+/// that don't also start with said base.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Default)]
+pub struct PatternList<T: Pattern> {
+ /// Patterns and their associated data in the order they were loaded in or specified,
+ /// the line number in its source file or its sequence number (_`(pattern, value, line_number)`_).
+ ///
+ /// During matching, this order is reversed.
+ pub patterns: Vec<PatternMapping<T::Value>>,
+
+ /// The path from which the patterns were read, or `None` if the patterns
+ /// don't originate in a file on disk.
+ pub source: Option<PathBuf>,
+
+ /// The parent directory of source, or `None` if the patterns are _global_ to match against the repository root.
+ /// It's processed to contain slashes only and to end with a trailing slash, and is relative to the repository root.
+ pub base: Option<BString>,
+}
+
+/// An association of a pattern with its value, along with a sequence number providing a sort order in relation to its peers.
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
+pub struct PatternMapping<T> {
+ /// The pattern itself, like `/target/*`
+ pub pattern: gix_glob::Pattern,
+ /// The value associated with the pattern.
+ pub value: T,
+ /// Typically the line number in the file the pattern was parsed from.
+ pub sequence_number: usize,
+}