substrait_explain/textify/

types.rs

use std::fmt;
use std::ops::Deref;

use ptype::parameter::Parameter;
use substrait::proto;
use substrait::proto::r#type::{self as ptype};

use super::foundation::{NONSPECIFIC, Scope};
use super::{PlanError, Textify};
use crate::extensions::simple::{CompoundName, ExtensionKind};
use crate::textify::foundation::{MaybeToken, Visibility};

const NULLABILITY_UNSPECIFIED: &str = "⁉";

impl Textify for ptype::Nullability {
    fn name() -> &'static str {
        "Nullability"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        match self {
            ptype::Nullability::Unspecified => {
                ctx.push_error(
                    PlanError::invalid("Nullability", NONSPECIFIC, "Nullability left Unspecified")
                        .into(),
                );

                // TODO: what should unspecified Nullabilitylook like?
                w.write_str(NULLABILITY_UNSPECIFIED)?;
            }
            ptype::Nullability::Nullable => write!(w, "?")?,
            ptype::Nullability::Required => {}
        };
        Ok(())
    }
}

/// A valid identifier is a sequence of ASCII letters, digits, and underscores,
/// starting with a letter.
///
/// We could expand this at some point to include any valid Unicode identifier
/// (see <https://docs.rs/unicode-ident/latest/unicode_ident/>), but that seems
/// overboard for now.
pub fn is_identifer(s: &str) -> bool {
    let mut chars = s.chars();
    let first = match chars.next() {
        Some(c) => c,
        None => return false,
    };

    if !first.is_ascii_alphabetic() {
        return false;
    }

    for c in chars {
        if !c.is_ascii_alphanumeric() && c != '_' {
            return false;
        }
    }

    true
}

/// Escape a string for use in a literal or quoted identifier.
pub fn escaped(s: &str) -> impl fmt::Display + fmt::Debug {
    s.escape_debug()
}

/// The name of a something to be represented. It will be displayed on its own
/// if the string is a proper identifier, or in double quotes if it is not.
#[derive(Debug, Copy, Clone)]
pub struct Name<'a>(pub &'a str);

impl<'a> fmt::Display for Name<'a> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if is_identifer(self.0) {
            write!(f, "{}", self.0)
        } else {
            write!(f, "\"{}\"", escaped(self.0))
        }
    }
}

impl<'a> Textify for Name<'a> {
    fn name() -> &'static str {
        "Name"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, _ctx: &S, w: &mut W) -> fmt::Result {
        write!(w, "{self}")
    }
}

#[derive(Debug, Copy, Clone)]
pub struct Anchor {
    reference: u32,
    required: bool,
}

impl Anchor {
    pub fn new(reference: u32, required: bool) -> Self {
        Self {
            reference,
            required,
        }
    }
}

impl Textify for Anchor {
    fn name() -> &'static str {
        "Anchor"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        match ctx.options().show_simple_extension_anchors {
            Visibility::Never => return Ok(()),
            Visibility::Required if !self.required => {
                return Ok(());
            }
            Visibility::Required => {}
            Visibility::Always => {}
        }
        write!(w, "#{}", self.reference)
    }
}

#[derive(Debug, Copy, Clone)]
pub struct NamedAnchor<'a> {
    /// The full stored compound name, e.g. `"equal:any_any"` or `"count:"`.
    pub name: MaybeToken<&'a CompoundName>,
    pub anchor: u32,
    /// True if the compound name is unique across all URNs for this extension
    /// kind (i.e. no other URN registers the same full compound name).
    /// anchor shown when `false`.
    pub unique: bool,
    /// True if the base name (part before the first `:`) is unique for this
    /// extension kind. signature shown when `false`.
    pub base_name_unique: bool,
}

impl<'a> NamedAnchor<'a> {
    /// Lookup an anchor in the extensions, and return a NamedAnchor.
    pub fn lookup<S: Scope>(ctx: &'a S, kind: ExtensionKind, anchor: u32) -> Self {
        if kind == ExtensionKind::Function {
            return match ctx.extensions().lookup_function(anchor) {
                Ok(r) => Self {
                    name: MaybeToken(Ok(r.name)),
                    anchor,
                    unique: r.name_unique,
                    base_name_unique: r.base_name_unique,
                },
                Err(e) => Self {
                    name: MaybeToken(Err(ctx.failure(e))),
                    anchor,
                    unique: false,
                    base_name_unique: false,
                },
            };
        }
        // For non-function kinds, use find_by_anchor + is_name_unique.
        // base_name_unique defaults to true since non-function names don't use
        // signature suffixes.
        let ext = ctx.extensions().find_by_anchor(kind, anchor);
        let (name, unique, base_name_unique) = match ext {
            Ok((_, n)) => {
                let unique = match ctx.extensions().is_name_unique(kind, anchor, n.full()) {
                    Ok(u) => u,
                    Err(e) => {
                        ctx.push_error(e.into());
                        false
                    }
                };
                (MaybeToken(Ok(n)), unique, true)
            }
            Err(e) => (MaybeToken(Err(ctx.failure(e))), false, false),
        };
        Self {
            name,
            anchor,
            unique,
            base_name_unique,
        }
    }
}

impl<'a> Textify for NamedAnchor<'a> {
    fn name() -> &'static str {
        "NamedAnchor"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        // Decide whether to show the full compound name or just the base name.
        let show_signature = match ctx.options().show_simple_extension_anchors {
            Visibility::Always => true,
            Visibility::Required => !self.base_name_unique,
            Visibility::Never => false,
        };

        match &self.name.0 {
            Ok(n) => {
                if show_signature {
                    write!(w, "{}", n.full())?;
                } else {
                    write!(w, "{}", n.base())?;
                }
            }
            Err(e) => write!(w, "{e}")?,
        }

        // Show the anchor when:
        // - The compound name is not unique (another URN uses the same name), OR
        // - The name is simple (no colon, e.g. "add") and the base name is not
        //   unique — without an anchor, "add" would be parsed as a base-name
        //   lookup and fail as ambiguous.
        let needs_anchor = !self.unique
            || match &self.name.0 {
                Ok(n) if !n.full().contains(':') => !self.base_name_unique,
                _ => false,
            };
        let anchor = Anchor::new(self.anchor, needs_anchor);
        write!(w, "{}", ctx.display(&anchor))
    }
}

/// The output type of a function call, rendered as `:type` after the argument list.
#[derive(Debug, Copy, Clone)]
pub struct OutputType<T: Deref<Target = proto::Type>>(pub Option<T>);

impl<T: Deref<Target = proto::Type>> Textify for OutputType<T> {
    fn name() -> &'static str {
        "OutputType"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        match self.0 {
            Some(ref t) => write!(w, ":{}", ctx.display(t.deref())),
            None => write!(
                w,
                "{}",
                ctx.failure(PlanError::invalid(
                    "OutputType",
                    None::<&str>,
                    "function output_type must be set",
                ))
            ),
        }
    }
}

struct TypeVariation(u32);

impl Textify for TypeVariation {
    fn name() -> &'static str {
        "TypeVariation"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        let &TypeVariation(anchor) = self;
        if anchor == 0 {
            // This is the default, this doesn't count as a type variation
            return Ok(());
        }
        let name_and_anchor = NamedAnchor::lookup(ctx, ExtensionKind::TypeVariation, anchor);

        write!(
            w,
            "[{name_and_anchor}]",
            name_and_anchor = ctx.display(&name_and_anchor)
        )
    }
}

// Textify a standard type with parameters.
//
// P will generally be the Parameter type, but it can be any type that
// implements Textify.
fn textify_type<S: Scope, W: fmt::Write>(
    ctx: &S,
    f: &mut W,
    name: impl AsRef<str>,
    nullability: ptype::Nullability,
    variant: u32,
    params: Parameters,
) -> fmt::Result {
    write!(
        f,
        "{name}{null}{var}{params}",
        name = name.as_ref(),
        null = ctx.display(&nullability),
        var = ctx.display(&TypeVariation(variant)),
        params = ctx.display(&params)
    )
}

macro_rules! textify_kind {
    ($ctx:expr, $f:expr, $kind:ident, $name:expr) => {
        textify_type(
            $ctx,
            $f,
            $name,
            $kind.nullability(),
            $kind.type_variation_reference,
            Parameters(&[]),
        )
    };
}

impl Textify for Parameter {
    fn name() -> &'static str {
        "Parameter"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        match self {
            Parameter::Boolean(true) => write!(w, "true")?,
            Parameter::Boolean(false) => write!(w, "false")?,
            Parameter::DataType(t) => write!(w, "{}", ctx.display(t))?,
            Parameter::Enum(e) => write!(w, "{e}")?,
            Parameter::Integer(i) => write!(w, "{i}")?,
            // TODO: Do we just put the string in directly?
            Parameter::String(s) => write!(w, "{s}")?,
            Parameter::Null(_) => write!(w, "null")?,
        };

        Ok(())
    }
}
impl Textify for ptype::Parameter {
    fn name() -> &'static str {
        "Parameter"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        write!(w, "{}", ctx.expect(self.parameter.as_ref()))
    }
}

struct Parameters<'a>(&'a [Option<Parameter>]);

impl<'a> Textify for Parameters<'a> {
    fn name() -> &'static str {
        "Parameters"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        let mut first = true;
        for param in self.0.iter() {
            if first {
                write!(w, "<")?;
            } else {
                write!(w, ", ")?;
            }
            write!(w, "{}", ctx.expect(param.as_ref()))?;
            first = false;
        }
        if !first {
            write!(w, ">")?;
        }

        Ok(())
    }
}

impl Textify for ptype::UserDefined {
    fn name() -> &'static str {
        "UserDefined"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        {
            let name_and_anchor =
                NamedAnchor::lookup(ctx, ExtensionKind::Type, self.type_reference);

            let param_vec: Vec<Option<Parameter>> = self
                .type_parameters
                .iter()
                .map(|t| t.parameter.clone())
                .collect();
            let params = Parameters(&param_vec);

            write!(
                w,
                "{name_and_anchor}{null}{var}{params}",
                name_and_anchor = ctx.display(&name_and_anchor),
                null = ctx.display(&self.nullability()),
                var = ctx.display(&TypeVariation(self.type_variation_reference)),
                params = ctx.display(&params)
            )
        }
    }
}

impl Textify for ptype::Kind {
    fn name() -> &'static str {
        "Kind"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        match self {
            // This is the expansion of:
            //     textify_kind!(ctx, w, k, "boolean")
            // Shown here for visibility
            ptype::Kind::Bool(k) => textify_type(
                ctx,
                w,
                "boolean",
                k.nullability(),
                k.type_variation_reference,
                Parameters(&[]),
            ),
            ptype::Kind::I8(k) => textify_kind!(ctx, w, k, "i8"),
            ptype::Kind::I16(k) => textify_kind!(ctx, w, k, "i16"),
            ptype::Kind::I32(k) => textify_kind!(ctx, w, k, "i32"),
            ptype::Kind::I64(k) => textify_kind!(ctx, w, k, "i64"),
            ptype::Kind::Fp32(k) => textify_kind!(ctx, w, k, "fp32"),
            ptype::Kind::Fp64(k) => textify_kind!(ctx, w, k, "fp64"),
            ptype::Kind::String(k) => textify_kind!(ctx, w, k, "string"),
            ptype::Kind::Binary(k) => textify_kind!(ctx, w, k, "binary"),
            #[allow(deprecated)]
            ptype::Kind::Timestamp(k) => textify_kind!(ctx, w, k, "timestamp"),
            ptype::Kind::Date(k) => textify_kind!(ctx, w, k, "date"),
            #[allow(deprecated)]
            ptype::Kind::Time(k) => textify_kind!(ctx, w, k, "time"),
            ptype::Kind::IntervalYear(i) => {
                textify_kind!(ctx, w, i, "interval_year")
            }
            #[allow(deprecated)]
            ptype::Kind::TimestampTz(ts) => {
                textify_kind!(ctx, w, ts, "timestamp_tz")
            }
            ptype::Kind::Uuid(uuid) => textify_kind!(ctx, w, uuid, "uuid"),

            ptype::Kind::IntervalDay(i) => textify_type(
                ctx,
                w,
                "interval_day",
                i.nullability(),
                i.type_variation_reference,
                // Precision defaults to 6 if unspecified
                Parameters(&[Some(Parameter::Integer(i.precision.unwrap_or(6) as i64))]),
            ),
            ptype::Kind::IntervalCompound(i) => textify_type(
                ctx,
                w,
                "interval_compound",
                i.nullability(),
                i.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(i.precision as i64))]),
            ),
            ptype::Kind::FixedChar(c) => textify_type(
                ctx,
                w,
                "fixedchar",
                c.nullability(),
                c.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(c.length as i64))]),
            ),
            ptype::Kind::Varchar(c) => textify_type(
                ctx,
                w,
                "varchar",
                c.nullability(),
                c.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(c.length as i64))]),
            ),
            ptype::Kind::FixedBinary(b) => textify_type(
                ctx,
                w,
                "fixedbinary",
                b.nullability(),
                b.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(b.length as i64))]),
            ),
            ptype::Kind::Decimal(d) => {
                let p = Parameter::Integer(d.precision as i64);
                let s = Parameter::Integer(d.scale as i64);
                textify_type(
                    ctx,
                    w,
                    "decimal",
                    d.nullability(),
                    d.type_variation_reference,
                    Parameters(&[Some(p), Some(s)]),
                )
            }
            ptype::Kind::PrecisionTime(p) => textify_type(
                ctx,
                w,
                "precisiontime",
                p.nullability(),
                p.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(p.precision as i64))]),
            ),
            ptype::Kind::PrecisionTimestamp(p) => textify_type(
                ctx,
                w,
                "precisiontimestamp",
                p.nullability(),
                p.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(p.precision as i64))]),
            ),
            ptype::Kind::PrecisionTimestampTz(p) => textify_type(
                ctx,
                w,
                "precisiontimestamptz",
                p.nullability(),
                p.type_variation_reference,
                Parameters(&[Some(Parameter::Integer(p.precision as i64))]),
            ),
            ptype::Kind::Struct(s) => textify_type(
                ctx,
                w,
                "struct",
                s.nullability(),
                s.type_variation_reference,
                Parameters(
                    &s.types
                        .iter()
                        .map(|t| Some(Parameter::DataType(t.clone())))
                        .collect::<Vec<_>>(),
                ),
            ),
            ptype::Kind::List(l) => {
                let p = l
                    .r#type
                    .as_ref()
                    .map(|t| Parameter::DataType((**t).to_owned()));
                textify_type(
                    ctx,
                    w,
                    "list",
                    l.nullability(),
                    l.type_variation_reference,
                    Parameters(&[p]),
                )
            }
            ptype::Kind::Map(m) => {
                let k = m
                    .key
                    .as_ref()
                    .map(|t| Parameter::DataType((**t).to_owned()));
                let v = m
                    .value
                    .as_ref()
                    .map(|t| Parameter::DataType((**t).to_owned()));
                textify_type(
                    ctx,
                    w,
                    "map",
                    m.nullability(),
                    m.type_variation_reference,
                    Parameters(&[k, v]),
                )
            }
            ptype::Kind::UserDefined(u) => u.textify(ctx, w),
            #[allow(deprecated)]
            ptype::Kind::UserDefinedTypeReference(r) => {
                // Defer to the UserDefined definition, using defaults for
                // variation, and non-nullable as suggested by the docs
                let udf = ptype::UserDefined {
                    type_reference: *r,
                    type_variation_reference: 0,
                    nullability: ptype::Nullability::Required as i32,
                    type_parameters: vec![],
                };
                ptype::Kind::UserDefined(udf).textify(ctx, w)
            }
            ptype::Kind::Func(_f) => {
                write!(
                    w,
                    "{}",
                    ctx.failure(PlanError::unimplemented(
                        "FuncType",
                        Some("Func"),
                        "Function type textification not implemented",
                    ))
                )
            }
            ptype::Kind::Alias(_p) => {
                write!(
                    w,
                    "{}",
                    ctx.failure(PlanError::unimplemented(
                        "AliasType",
                        Some("Alias"),
                        "TypeAliasReference textification not implemented",
                    ))
                )
            }
        }
    }
}

impl Textify for proto::Type {
    fn name() -> &'static str {
        "Type"
    }

    fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
        write!(w, "{}", ctx.expect(self.kind.as_ref()))
    }
}

// /// A schema is a named struct with a list of fields.
// ///
// /// This outputs the names and types of the fields in the struct,
// /// comma-separated.
// ///
// /// Assumes that the struct is not nullable, that the type variation reference
// /// is 0, and that the names and fields match up; otherwise, pushes errors.
// ///
// /// Names and fields are output without any bracketing; bring your own
// /// bracketing.
// pub struct Schema<'a>(pub &'a proto::NamedStruct);

// impl<'a> Textify for Schema<'a> {
//     fn name() -> &'static str {
//         "Schema"
//     }

//     fn textify<S: Scope, W: fmt::Write>(&self, ctx: &S, w: &mut W) -> fmt::Result {
//         let mut fields = self
//             .0
//             .r#struct
//             .as_ref()
//             .map(|s| s.types.iter())
//             .into_iter()
//             .flatten();
//         let mut names = self.0.names.iter();

//         let field_count = self.0.r#struct.as_ref().map(|s| s.types.len()).unwrap_or(0);
//         let name_count = self.0.names.len();

//         if field_count != name_count {
//             ctx.push_error(
//                 TextifyError::invalid(
//                     "Schema",
//                     NONSPECIFIC,
//                     format!(
//                         "Field count ({}) does not match name count ({})",
//                         field_count, name_count
//                     ),
//                 )
//                 .into(),
//             );
//         }

//         write!(w, "[")?;
//         let mut first = true;
//         loop {
//             let field = fields.next();
//             let name = names.next().map(|n| Name(n));
//             if field.is_none() && name.is_none() {
//                 break;
//             }

//             if first {
//                 first = false;
//             } else {
//                 write!(w, ", ")?;
//             }

//             write!(w, "{}:{}", ctx.expect(name.as_ref()), ctx.expect(field))?;
//         }
//         write!(w, "]")?;

//         let s = match &self.0.r#struct {
//             None => return Ok(()),
//             Some(s) => s,
//         };

//         if s.nullability() != Nullability::Required {
//             ctx.push_error(
//                 TextifyError::invalid(
//                     "Schema",
//                     Some("nullabilility"),
//                     "Expected schema to be Nullability::Required",
//                 )
//                 .into(),
//             );
//             s.nullability().textify(ctx, w)?;
//         }
//         if s.type_variation_reference != 0 {
//             ctx.push_error(
//                 TextifyError::invalid(
//                     "Schema",
//                     Some("type_variation_reference"),
//                     "Expected schema to have type_variation_reference 0",
//                 )
//                 .into(),
//             );
//             TypeVariation(s.type_variation_reference).textify(ctx, w)?;
//         }

//         Ok(())
//     }
// }

#[cfg(test)]
mod tests {

    use super::*;
    use crate::extensions::simple::{ExtensionKind, MissingReference};
    use crate::fixtures::TestContext;
    use crate::textify::foundation::FormatError;

    #[test]
    fn type_display() {
        let ctx = TestContext::new()
            .with_urn(1, "first")
            .with_type_variation(1, 2, "u8");

        let t = proto::Type {
            kind: Some(ptype::Kind::Bool(ptype::Boolean {
                type_variation_reference: 2,
                nullability: ptype::Nullability::Nullable as i32,
            })),
        };

        let s = ctx.textify_no_errors(&t);
        assert_eq!(s, "boolean?[u8]");

        let t = proto::Type {
            kind: Some(ptype::Kind::I8(ptype::I8 {
                type_variation_reference: 0,
                nullability: ptype::Nullability::Required as i32,
            })),
        };
        assert_eq!(ctx.textify_no_errors(&t), "i8");

        let t = proto::Type {
            kind: Some(ptype::Kind::PrecisionTimestamp(ptype::PrecisionTimestamp {
                type_variation_reference: 0,
                nullability: ptype::Nullability::Nullable as i32,
                precision: 3,
            })),
        };
        assert_eq!(ctx.textify_no_errors(&t), "precisiontimestamp?<3>");

        let mut ctx = ctx.with_type_variation(1, 8, "int");
        ctx.options.show_simple_extension_anchors = Visibility::Always;

        let t = proto::Type {
            kind: Some(ptype::Kind::PrecisionTime(ptype::PrecisionTime {
                type_variation_reference: 8,
                nullability: ptype::Nullability::Nullable as i32,
                precision: 9,
            })),
        };
        assert_eq!(ctx.textify_no_errors(&t), "precisiontime?[int#8]<9>");
    }

    #[test]
    fn type_display_with_errors() {
        let ctx = TestContext::new()
            .with_urn(1, "first")
            .with_type(1, 100, "cow");

        let t = proto::Type {
            kind: Some(ptype::Kind::Bool(ptype::Boolean {
                type_variation_reference: 200,
                nullability: ptype::Nullability::Nullable as i32,
            })),
        };
        let (s, errs) = ctx.textify(&t);
        assert_eq!(s, "boolean?[!{type_variation}#200]");
        let err = errs.first();
        let (&k, &a) = match err {
            FormatError::Lookup(MissingReference::MissingAnchor(k, a)) => (k, a),
            _ => panic!("Expected Lookup MissingAnchor: {err}"),
        };

        assert_eq!(k, ExtensionKind::TypeVariation);
        assert_eq!(a, 200);

        let t = proto::Type {
            kind: Some(ptype::Kind::UserDefined(ptype::UserDefined {
                type_variation_reference: 0,
                nullability: ptype::Nullability::Required as i32,
                type_reference: 100,
                type_parameters: vec![],
            })),
        };

        let (s, errs) = ctx.textify(&t);
        assert!(errs.is_empty());
        assert_eq!(s, "cow");

        let t = proto::Type {
            kind: Some(ptype::Kind::UserDefined(ptype::UserDefined {
                type_variation_reference: 0,
                nullability: ptype::Nullability::Required as i32,
                type_reference: 12589,
                type_parameters: vec![],
            })),
        };

        let (s, errs) = ctx.textify(&t);
        let err = errs.first();
        let (&k, &a) = match err {
            FormatError::Lookup(MissingReference::MissingAnchor(k, a)) => (k, a),
            _ => panic!("Expected Lookup MissingAnchor: {err}"),
        };
        assert_eq!(k, ExtensionKind::Type);
        assert_eq!(a, 12589);
        assert_eq!(s, "!{type}#12589");
    }

    #[test]
    fn struct_display() {
        let ctx = TestContext::new();
        let t = proto::Type {
            kind: Some(ptype::Kind::Struct(ptype::Struct {
                type_variation_reference: 0,
                nullability: ptype::Nullability::Nullable as i32,
                types: vec![
                    proto::Type {
                        kind: Some(ptype::Kind::String(ptype::String {
                            type_variation_reference: 0,
                            nullability: ptype::Nullability::Required as i32,
                        })),
                    },
                    proto::Type {
                        kind: Some(ptype::Kind::I8(ptype::I8 {
                            type_variation_reference: 0,
                            nullability: ptype::Nullability::Required as i32,
                        })),
                    },
                    proto::Type {
                        kind: Some(ptype::Kind::I32(ptype::I32 {
                            type_variation_reference: 0,
                            nullability: ptype::Nullability::Nullable as i32,
                        })),
                    },
                    proto::Type {
                        #[allow(deprecated)] // TimestampTz is deprecated
                        kind: Some(ptype::Kind::TimestampTz(ptype::TimestampTz {
                            type_variation_reference: 0,
                            nullability: ptype::Nullability::Required as i32,
                        })),
                    },
                ],
            })),
        };
        assert_eq!(
            ctx.textify_no_errors(&t),
            "struct?<string, i8, i32?, timestamp_tz>"
        );
    }

    #[test]
    fn names_display() {
        let ctx = TestContext::new();

        let n = Name("name");
        assert_eq!(ctx.textify_no_errors(&n), "name");

        let n = Name("name with spaces");
        assert_eq!(ctx.textify_no_errors(&n), "\"name with spaces\"");
    }

    // #[test]
    // fn schema_display() {
    //     let ctx = TestContext::new();

    //     let s = ptype::Struct {
    //         type_variation_reference: 0,
    //         nullability: ptype::Nullability::Required as i32,
    //         types: vec![
    //             proto::Type {
    //                 kind: Some(ptype::Kind::String(ptype::String {
    //                     type_variation_reference: 0,
    //                     nullability: ptype::Nullability::Required as i32,
    //                 })),
    //             },
    //             proto::Type {
    //                 kind: Some(ptype::Kind::I8(ptype::I8 {
    //                     type_variation_reference: 0,
    //                     nullability: ptype::Nullability::Required as i32,
    //                 })),
    //             },
    //             proto::Type {
    //                 kind: Some(ptype::Kind::I32(ptype::I32 {
    //                     type_variation_reference: 0,
    //                     nullability: ptype::Nullability::Nullable as i32,
    //                 })),
    //             },
    //             proto::Type {
    //                 kind: Some(ptype::Kind::TimestampTz(ptype::TimestampTz {
    //                     type_variation_reference: 0,
    //                     nullability: ptype::Nullability::Required as i32,
    //                 })),
    //             },
    //         ],
    //     };

    //     let names = ["a", "b", "c", "d"].iter().map(|s| s.to_string()).collect();
    //     let schema = proto::NamedStruct {
    //         names,
    //         r#struct: Some(s),
    //     };

    //     assert_eq!(
    //         ctx.textify_no_errors(&Schema(&schema)),
    //         "[a:string, b:i8, c:i32?, d:timestamp_tz]"
    //     );
    // }

    // #[test]
    // fn schema_display_with_errors() {
    //     let ctx = TestContext::new();
    //     let string = proto::Type {
    //         kind: Some(ptype::Kind::String(ptype::String {
    //             type_variation_reference: 0,
    //             nullability: ptype::Nullability::Required as i32,
    //         })),
    //     };
    //     let i64 = proto::Type {
    //         kind: Some(ptype::Kind::I8(ptype::I8 {
    //             type_variation_reference: 0,
    //             nullability: ptype::Nullability::Nullable as i32,
    //         })),
    //     };
    //     let fp64 = proto::Type {
    //         kind: Some(ptype::Kind::Fp64(ptype::Fp64 {
    //             type_variation_reference: 0,
    //             nullability: ptype::Nullability::Nullable as i32,
    //         })),
    //     };

    //     let s = ptype::Struct {
    //         type_variation_reference: 0,
    //         nullability: ptype::Nullability::Required as i32,
    //         types: vec![string.clone(), i64, fp64, string],
    //     };

    //     let names = ["name", "id", "distance", "street address"]
    //         .iter()
    //         .map(|s| s.to_string())
    //         .collect();
    //     let schema = proto::NamedStruct {
    //         names,
    //         r#struct: Some(s),
    //     };

    //     let (s, errs) = ctx.textify(&Schema(&schema));
    //     assert_eq!(
    //         s,
    //         "name:string, id:i8?, distance:fp64?, \"street address\":string"
    //     );
    //     assert!(errs.is_empty());
    // }

    // ---- Tests for NamedAnchor signature display ----

    /// Build a TestContext with two overloaded functions (`equal:any_any` and
    /// `equal:str_str`) sharing the same URN, plus a unique function (`add`).
    fn overloaded_ctx() -> TestContext {
        TestContext::new()
            .with_urn(1, "substrait:functions_comparison")
            .with_function(1, 1, "equal:any_any")
            .with_function(1, 2, "equal:str_str")
            .with_function(1, 3, "add:i64_i64")
    }

    #[test]
    fn named_anchor_compact_unique_base_name_no_signature() {
        // `add:i64_i64` is the only function with base name "add".
        // Compact mode: show base name only, no anchor (compound name unique).
        let ctx = overloaded_ctx();
        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 3);
        assert!(na.base_name_unique, "add should have unique base name");
        assert!(na.unique, "add:i64_i64 compound name should be unique");

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "add");
    }

    #[test]
    fn named_anchor_compact_overloaded_shows_signature() {
        // `equal:any_any` shares base name "equal" with `equal:str_str`.
        // Compact mode: base name not unique → show full compound name.
        // Compound name is unique (only one URN) → no anchor.
        let ctx = overloaded_ctx();
        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 1);
        assert!(!na.base_name_unique, "equal base name should not be unique");
        assert!(
            na.unique,
            "equal:any_any compound name should be unique across URNs"
        );

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "equal:any_any");
    }

    #[test]
    fn named_anchor_verbose_unique_base_name_shows_signature_and_anchor() {
        // Verbose mode: always show signature and always show anchor.
        let mut ctx = overloaded_ctx();
        ctx.options.show_simple_extension_anchors = Visibility::Always;

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 3);
        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "add:i64_i64#3");
    }

    #[test]
    fn named_anchor_verbose_overloaded_shows_signature_and_anchor() {
        // Verbose mode: overloaded function shows full compound name + anchor.
        let mut ctx = overloaded_ctx();
        ctx.options.show_simple_extension_anchors = Visibility::Always;

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 2);
        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "equal:str_str#2");
    }

    #[test]
    fn named_anchor_compact_same_compound_name_two_urns_shows_anchor() {
        // Same compound name `equal:any_any` registered in two different URNs.
        // Compact mode: compound name not unique → anchor required.
        let ctx = TestContext::new()
            .with_urn(1, "urn_a")
            .with_urn(2, "urn_b")
            .with_function(1, 1, "equal:any_any")
            .with_function(2, 2, "equal:any_any");

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 1);
        assert!(!na.base_name_unique);
        assert!(!na.unique, "compound name not unique across two URNs");

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "equal:any_any#1");
    }

    #[test]
    fn named_anchor_compact_unique_full_name_zero_arg_type_signature() {
        // "count:" is the only function with base "count".
        // Compact mode: base name unique → write base name only, no anchor.
        // "count:" and "count:i64" are not conceptually different;
        // both write just the base name when unambiguous.
        let ctx = TestContext::new()
            .with_urn(1, "urn")
            .with_function(1, 5, "count:");

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 5);
        assert!(na.base_name_unique);
        assert!(na.unique);

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "count");
    }

    #[test]
    fn named_anchor_verbose_full_name_shows_signature_and_anchor() {
        // Verbose mode: always writes full() + anchor.
        let mut ctx = TestContext::new()
            .with_urn(1, "urn")
            .with_function(1, 5, "count:");
        ctx.options.show_simple_extension_anchors = Visibility::Always;

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 5);

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "count:#5");
    }

    #[test]
    fn named_anchor_compact_plain_name_unique_no_signature_no_anchor() {
        let ctx = TestContext::new()
            .with_urn(1, "urn")
            .with_function(1, 10, "coalesce");

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 10);
        assert!(na.base_name_unique);
        assert!(na.unique);

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "coalesce");
    }

    #[test]
    fn named_anchor_compact_plain_name_non_unique_shows_anchor() {
        let ctx = TestContext::new()
            .with_urn(1, "urn1")
            .with_urn(2, "urn2")
            .with_function(1, 231, "duplicated")
            .with_function(2, 232, "duplicated");

        let eq = crate::textify::ErrorQueue::default();
        let scope = ctx.scope(&eq);
        let na = NamedAnchor::lookup(&scope, ExtensionKind::Function, 231);
        assert!(!na.base_name_unique);
        assert!(!na.unique);

        let s = ctx.textify_no_errors(&na);
        assert_eq!(s, "duplicated#231");
    }
}