aboutsummaryrefslogtreecommitdiff
path: root/mingling_picker/src/flag.rs
diff options
context:
space:
mode:
Diffstat (limited to 'mingling_picker/src/flag.rs')
-rw-r--r--mingling_picker/src/flag.rs285
1 files changed, 0 insertions, 285 deletions
diff --git a/mingling_picker/src/flag.rs b/mingling_picker/src/flag.rs
deleted file mode 100644
index 33c7829..0000000
--- a/mingling_picker/src/flag.rs
+++ /dev/null
@@ -1,285 +0,0 @@
-use crate::Pickable;
-use std::marker::PhantomData;
-
-/// Represents a constraint definition for a parameter selection.
-///
-/// This structure describes the constraints that a command-line parameter (Picker parameter item)
-/// should satisfy, including its full name list (with aliases), short name form, and whether it is
-/// positional.
-///
-/// # Field Descriptions
-///
-/// - `full`: Full name or alias list. For example, `["config", "cfg"]` means the parameter can be
-/// matched with either `--config` or `--cfg`. Must contain at least one non-empty string.
-///
-/// - `short`: Short name (single character). For example, `Some('c')` means it can be passed using
-/// the `-c` form. If set to `None`, the short name form is not supported.
-///
-/// - `positional`: Whether the parameter is positional (i.e., an argument without a flag).
-/// - `true`: The parameter is positional; it is matched by its position in the command line rather
-/// than by a `--name` or `-n` flag.
-/// - `false`: The parameter is a named (flag-based) parameter.
-///
-/// - `_type`: PhantomData to hold the type parameter.
-#[derive(Default, Clone, Copy)]
-pub struct PickerFlag<'a, Type>
-where
- Type: Pickable<'a>,
-{
- /// Full name, may include variant names (aliases), e.g., `["config", "cfg"]`.
- pub full: &'a [&'a str],
-
- /// Short name, e.g., `'c'`.
- pub short: Option<char>,
-
- /// Whether the parameter is positional (no flag, matched by position).
- pub positional: bool,
-
- /// PhantomData to hold the type parameter.
- pub internal_type: PhantomData<Type>,
-}
-
-impl<'a, Type> PickerFlag<'a, Type>
-where
- Type: Pickable<'a>,
-{
- /// Creates a new `PickerFlag` with the provided parameters.
- pub fn new(full: &'a [&'a str], short: Option<char>, positional: bool) -> Self {
- Self {
- full,
- short,
- positional,
- internal_type: PhantomData,
- }
- }
-
- /// Returns the full name list (including aliases).
- pub fn full(&self) -> &'a [&'a str] {
- self.full
- }
-
- /// Returns the short name, if any.
- pub fn short(&self) -> Option<char> {
- self.short
- }
-
- /// Returns whether the parameter is positional.
- ///
- /// If `full` is empty or `short` is `None`, the parameter is considered positional
- /// regardless of the stored value.
- pub fn is_positional(&self) -> bool {
- if self.full.is_empty() && self.short.is_none() {
- true
- } else {
- self.positional
- }
- }
-
- /// Sets the full name list.
- pub fn set_full(&mut self, full: &'a [&'a str]) {
- self.full = full;
- }
-
- /// Sets the short name.
- pub fn set_short(&mut self, short: Option<char>) {
- self.short = short;
- }
-
- /// Sets whether the parameter is positional.
- pub fn set_positional(&mut self, positional: bool) {
- self.positional = positional;
- }
-
- /// Sets the full name list and returns self.
- pub fn with_full(mut self, full: &'a [&'a str]) -> Self {
- self.full = full;
- self
- }
-
- /// Clears the full name list (sets it to an empty slice) and returns self.
- pub fn without_full(mut self) -> Self {
- self.full = &[];
- self
- }
-
- /// Sets the short name to the given character and returns self.
- pub fn with_short(mut self, short: char) -> Self {
- self.short = Some(short);
- self
- }
-
- /// Clears the short name (sets it to None) and returns self.
- pub fn without_short(mut self) -> Self {
- self.short = None;
- self
- }
-
- /// Sets whether the parameter is positional and returns self.
- pub fn with_positional(mut self, positional: bool) -> Self {
- self.positional = positional;
- self
- }
-}
-
-/// Describes the attribute (behavior) of a command-line parameter.
-///
-/// The ordering reflects parse priority (higher = parsed first):
-/// `Positional < PositionalMulti < Flag < Single < Multi`
-#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
-pub enum PickerFlagAttr {
- /// Positional argument matched by its position (e.g., an input file).
- #[default]
- Positional,
-
- /// Positional argument that accepts multiple values (e.g., multiple input files).
- PositionalMulti,
-
- /// Boolean flag with no associated value (e.g., `--verbose`).
- Flag,
-
- /// Accepts a single value (e.g., `--name Alice`).
- Single,
-
- /// Accepts multiple values (e.g., `--file a.txt --file b.txt`).
- Multi,
-}
-
-impl PickerFlagAttr {
- /// Determines if the given `PickerFlag` represents a positional parameter.
- ///
- /// If the flag is positional (determined by `flag.is_positional()`), returns
- /// `PickerFlagAttr::Positional`. Otherwise, invokes the `other` closure to
- /// produce and return a `PickerFlagAttr`.
- ///
- /// # Parameters
- ///
- /// - `flag`: A reference to the [`PickerFlag`] to evaluate.
- /// - `other`: A closure that returns a [`PickerFlagAttr`] when the flag is
- /// **not** positional.
- #[inline(always)]
- pub fn positional_or_else<'a, T>(
- flag: &PickerFlag<'a, T>,
- other: fn() -> PickerFlagAttr,
- ) -> PickerFlagAttr
- where
- T: Pickable<'a>,
- {
- if flag.is_positional() {
- PickerFlagAttr::Positional
- } else {
- other()
- }
- }
-
- /// Determines if the given `PickerFlag` represents a positional parameter and returns
- /// `PickerFlagAttr::Positional` if so. Otherwise, returns the provided `default` attribute.
- ///
- /// # Parameters
- ///
- /// - `flag`: A reference to the [`PickerFlag`] to evaluate.
- /// - `default`: The [`PickerFlagAttr`] to return if the flag is not positional.
- #[inline(always)]
- pub fn positional_or<'a, T>(flag: &PickerFlag<'a, T>, default: PickerFlagAttr) -> PickerFlagAttr
- where
- T: Pickable<'a>,
- {
- if flag.is_positional() {
- PickerFlagAttr::Positional
- } else {
- default
- }
- }
-
- /// Determines if the given `PickerFlag` represents a positional parameter and returns
- /// `PickerFlagAttr::Positional` if so. Otherwise, returns `PickerFlagAttr::Single`.
- ///
- /// # Parameters
- ///
- /// - `flag`: A reference to the [`PickerFlag`] to evaluate.
- #[inline(always)]
- pub fn positional_or_single<'a, T>(flag: &PickerFlag<'a, T>) -> PickerFlagAttr
- where
- T: Pickable<'a>,
- {
- if flag.is_positional() {
- PickerFlagAttr::Positional
- } else {
- PickerFlagAttr::Single
- }
- }
-
- /// Determines if the given `PickerFlag` represents a positional parameter and returns
- /// `PickerFlagAttr::PositionalMulti` if so. Otherwise, returns `PickerFlagAttr::Multi`.
- ///
- /// # Parameters
- ///
- /// - `flag`: A reference to the [`PickerFlag`] to evaluate.
- #[inline(always)]
- pub fn positional_or_multi<'a, T>(flag: &PickerFlag<'a, T>) -> PickerFlagAttr
- where
- T: Pickable<'a>,
- {
- if flag.is_positional() {
- PickerFlagAttr::PositionalMulti
- } else {
- PickerFlagAttr::Multi
- }
- }
-}
-
-#[cfg(test)]
-mod tests {
- use super::*;
-
- #[test]
- fn test_picker_flag_attr_ordering() {
- // Multi > Single > Flag > PositionalMulti > Positional
- assert!(PickerFlagAttr::Multi > PickerFlagAttr::Single);
- assert!(PickerFlagAttr::Multi > PickerFlagAttr::Flag);
- assert!(PickerFlagAttr::Multi > PickerFlagAttr::PositionalMulti);
- assert!(PickerFlagAttr::Multi > PickerFlagAttr::Positional);
-
- assert!(PickerFlagAttr::Single > PickerFlagAttr::Flag);
- assert!(PickerFlagAttr::Single > PickerFlagAttr::PositionalMulti);
- assert!(PickerFlagAttr::Single > PickerFlagAttr::Positional);
-
- assert!(PickerFlagAttr::Flag > PickerFlagAttr::PositionalMulti);
- assert!(PickerFlagAttr::Flag > PickerFlagAttr::Positional);
-
- assert!(PickerFlagAttr::PositionalMulti > PickerFlagAttr::Positional);
-
- // PartialOrd
- assert!(PickerFlagAttr::Multi >= PickerFlagAttr::Single);
- assert!(PickerFlagAttr::Single >= PickerFlagAttr::Flag);
- assert!(PickerFlagAttr::Flag >= PickerFlagAttr::PositionalMulti);
- assert!(PickerFlagAttr::PositionalMulti >= PickerFlagAttr::Positional);
-
- assert!(PickerFlagAttr::Positional < PickerFlagAttr::PositionalMulti);
- assert!(PickerFlagAttr::PositionalMulti < PickerFlagAttr::Flag);
- assert!(PickerFlagAttr::Flag < PickerFlagAttr::Single);
- assert!(PickerFlagAttr::Single < PickerFlagAttr::Multi);
- }
-
- #[test]
- fn test_picker_flag_attr_sorting() {
- // Sort
- let mut values = vec![
- PickerFlagAttr::Flag,
- PickerFlagAttr::Single,
- PickerFlagAttr::Positional,
- PickerFlagAttr::Multi,
- PickerFlagAttr::PositionalMulti,
- ];
- values.sort();
- assert_eq!(
- values,
- vec![
- PickerFlagAttr::Positional,
- PickerFlagAttr::PositionalMulti,
- PickerFlagAttr::Flag,
- PickerFlagAttr::Single,
- PickerFlagAttr::Multi,
- ]
- );
- }
-}