usage_config/

props.rs

//! What `#[derive(usage::Config)]` generates, and how flattened groups compose.
//!
//! A derive expansion sees one struct. A settings struct that flattens another — pitchfork
//! keeps eight groups in eight structs — therefore joins tables through this trait's
//! associated const, the same way `usage::Cli` joins a flattened group's flags: the child
//! declares its own slice, and the parent concatenates at compile time. Nothing is assembled
//! at run time, and a prop's id is its position in the joined slice.

use crate::read::Fold;
use crate::registry::PropMeta;
use crate::spec::PropSpec;

/// A group of settings declared in code.
///
/// Implemented by `#[derive(usage::Config)]`, not by hand: the derive is what keeps
/// [`Props::PROPS`] and [`Props::read_at`] describing the same fields in the same order,
/// which is the invariant everything here leans on.
pub trait Props: Sized {
    /// This group's settings, in declaration order.
    ///
    /// A flattened child's props follow the parent's own, so an id is a position in the
    /// parent's joined slice — which is why reading takes a `base`.
    const PROPS: &'static [PropMeta];

    /// Spec-only metadata parallel to [`Props::PROPS`].
    const PROP_SPECS: &'static [PropSpec];

    /// Read this group's fields from a fold, its props starting at `base`.
    ///
    /// `None` means a field could not be read and the fold has recorded why. Every field is
    /// still visited first — the errors are a list, not the first thing found — so a caller
    /// checks [`Fold::finish`] before treating `None` as anything but "already reported".
    #[doc(hidden)]
    fn read_at(fold: &mut Fold<'_>, base: u16) -> Option<Self>;
}

/// Join flattened groups' spec metadata in the same order as their properties.
pub const fn concat_prop_specs<const N: usize>(groups: &[&[PropSpec]]) -> [PropSpec; N] {
    let mut out = [PropSpec::EMPTY; N];
    let mut at = 0;
    let mut g = 0;
    while g < groups.len() {
        let group = groups[g];
        let mut i = 0;
        while i < group.len() {
            out[at] = group[i];
            at += 1;
            i += 1;
        }
        g += 1;
    }
    assert!(
        at == N,
        "`N` must be the summed length of the groups, or property spec metadata would not \
         line up with its setting"
    );
    out
}

/// Join groups of prop metadata into one slice, at compile time.
///
/// The settings counterpart of `usage_argv::spec::concat_flag_metas`, for the same reason: a
/// flattened struct's props belong in the parent's registry, and the parent's macro expansion
/// has only a type to reach them through.
///
/// `N` must be the summed length of `groups`. Two groups claiming the same *name* are refused
/// here, at compile time — the parent and the struct it flattens each declared it, a collision
/// neither expansion can see. A name is a key or an alias, because [`Registry::lookup`] checks
/// both and takes the first match: an alias colliding with another group's key makes one of
/// the two unreachable by that name, which is the same bug as a duplicate key and quieter.
///
/// [`Registry::lookup`]: crate::Registry::lookup
pub const fn concat_props<const N: usize>(groups: &[&[PropMeta]]) -> [PropMeta; N] {
    let mut out = [PropMeta::new("", crate::ty::Ty::Any); N];
    let mut at = 0;
    let mut g = 0;
    while g < groups.len() {
        let group = groups[g];
        let mut i = 0;
        while i < group.len() {
            out[at] = group[i];
            at += 1;
            i += 1;
        }
        g += 1;
    }
    assert!(
        at == N,
        "`N` must be the summed length of the groups, or the registry would describe a \
         setting that does not exist"
    );
    let mut a = 0;
    while a < N {
        let mut b = a + 1;
        while b < N {
            assert!(
                !str_eq(out[a].key, out[b].key),
                "two flattened groups declare the same setting key, so one of them could \
                 never be reached: give one of them another key or prefix"
            );
            // Each one's key against the other's aliases, and then alias against alias. A
            // lookup does not care which kind of name it matched, so neither can this.
            assert!(
                !names_any(out[a].key, out[b].aliases),
                "one flattened group's setting key is another's alias, so a lookup for that \
                 name could only ever reach one of them: rename one of the two"
            );
            assert!(
                !names_any(out[b].key, out[a].aliases),
                "one flattened group's setting key is another's alias, so a lookup for that \
                 name could only ever reach one of them: rename one of the two"
            );
            let mut i = 0;
            while i < out[a].aliases.len() {
                assert!(
                    !names_any(out[a].aliases[i], out[b].aliases),
                    "two flattened groups declare the same alias, so a lookup for it could \
                     only ever reach one of them: rename one of the two"
                );
                i += 1;
            }
            b += 1;
        }
        a += 1;
    }
    out
}

/// Whether `name` is one of `names`, in a const context.
const fn names_any(name: &str, names: &[&str]) -> bool {
    let mut i = 0;
    while i < names.len() {
        if str_eq(name, names[i]) {
            return true;
        }
        i += 1;
    }
    false
}

/// Whether two strings are equal, in a const context.
const fn str_eq(a: &str, b: &str) -> bool {
    let a = a.as_bytes();
    let b = b.as_bytes();
    if a.len() != b.len() {
        return false;
    }
    let mut i = 0;
    while i < a.len() {
        if a[i] != b[i] {
            return false;
        }
        i += 1;
    }
    true
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ty::Ty;

    /// The refusals, exercised at run time.
    ///
    /// `concat_props` is a `const fn`, so in its real use — a `static` initializer — these
    /// assertions are a compile error, which a test cannot observe. Called at run time the
    /// same assertion panics, which one can.
    mod one_name_reaches_one_setting {
        use super::*;

        #[test]
        #[should_panic(expected = "same setting key")]
        fn two_groups_cannot_declare_one_key() {
            static A: &[PropMeta] = &[PropMeta::new("jobs", Ty::Uint)];
            static B: &[PropMeta] = &[PropMeta::new("jobs", Ty::Uint)];
            let _ = concat_props::<2>(&[A, B]);
        }

        #[test]
        #[should_panic(expected = "is another's alias")]
        fn an_alias_cannot_shadow_another_groups_key() {
            static A: &[PropMeta] = &[PropMeta {
                aliases: &["threads"],
                ..PropMeta::new("jobs", Ty::Uint)
            }];
            static B: &[PropMeta] = &[PropMeta::new("threads", Ty::Uint)];
            let _ = concat_props::<2>(&[A, B]);
        }

        /// The same collision found from the other side, which is a separate comparison.
        #[test]
        #[should_panic(expected = "is another's alias")]
        fn a_key_cannot_be_shadowed_by_a_later_groups_alias() {
            static A: &[PropMeta] = &[PropMeta::new("threads", Ty::Uint)];
            static B: &[PropMeta] = &[PropMeta {
                aliases: &["threads"],
                ..PropMeta::new("jobs", Ty::Uint)
            }];
            let _ = concat_props::<2>(&[A, B]);
        }

        #[test]
        #[should_panic(expected = "same alias")]
        fn two_groups_cannot_declare_one_alias() {
            static A: &[PropMeta] = &[PropMeta {
                aliases: &["shared"],
                ..PropMeta::new("jobs", Ty::Uint)
            }];
            static B: &[PropMeta] = &[PropMeta {
                aliases: &["shared"],
                ..PropMeta::new("threads", Ty::Uint)
            }];
            let _ = concat_props::<2>(&[A, B]);
        }

        /// And distinct names join, which is the case that has to keep working.
        #[test]
        fn distinct_names_join() {
            static A: &[PropMeta] = &[PropMeta {
                aliases: &["concurrency"],
                ..PropMeta::new("jobs", Ty::Uint)
            }];
            static B: &[PropMeta] = &[PropMeta {
                aliases: &["task.concurrency"],
                ..PropMeta::new("task.jobs", Ty::Uint)
            }];
            let joined = concat_props::<2>(&[A, B]);
            assert_eq!(joined[0].key, "jobs");
            assert_eq!(joined[1].key, "task.jobs");
        }
    }

    #[test]
    fn groups_join_in_order_and_ids_are_positions() {
        static OWN: &[PropMeta] = &[PropMeta::new("jobs", Ty::Uint)];
        static CHILD: &[PropMeta] = &[
            PropMeta::new("task.output", Ty::String),
            PropMeta::new("task.jobs", Ty::Uint),
        ];
        const N: usize = OWN.len() + CHILD.len();
        static JOINED: [PropMeta; N] = concat_props(&[OWN, CHILD]);
        assert_eq!(JOINED[0].key, "jobs");
        assert_eq!(JOINED[1].key, "task.output");
        assert_eq!(JOINED[2].key, "task.jobs");
    }

    #[test]
    fn spec_metadata_joins_in_the_same_order_as_props() {
        static OWN: &[PropSpec] = &[PropSpec {
            help_heading: Some("Performance"),
            writes_to: None,
            extensions: &[],
        }];
        static CHILD: &[PropSpec] = &[
            PropSpec {
                writes_to: Some("git"),
                ..PropSpec::EMPTY
            },
            PropSpec::EMPTY,
        ];
        const N: usize = OWN.len() + CHILD.len();
        static JOINED: [PropSpec; N] = concat_prop_specs(&[OWN, CHILD]);
        assert_eq!(JOINED[0].help_heading, Some("Performance"));
        assert_eq!(JOINED[1].writes_to, Some("git"));
        assert_eq!(JOINED[2], PropSpec::EMPTY);
    }
}