ide/hover/

render.rs

//! Logic for rendering the different hover messages
use std::{borrow::Cow, env, mem, ops::Not};

use either::Either;
use hir::{
    Adt, AsAssocItem, AsExternAssocItem, CaptureKind, DisplayTarget, DropGlue,
    DynCompatibilityViolation, HasCrate, HasSource, HirDisplay, Layout, LayoutError,
    MethodViolationCode, Name, Semantics, Symbol, Trait, Type, TypeInfo, Variant,
};
use ide_db::{
    RootDatabase,
    defs::{Definition, find_std_module},
    documentation::{Documentation, HasDocs},
    famous_defs::FamousDefs,
    generated::lints::{CLIPPY_LINTS, DEFAULT_LINTS, FEATURES},
    syntax_helpers::prettify_macro_expansion,
};
use itertools::Itertools;
use rustc_apfloat::{
    Float,
    ieee::{Half as f16, Quad as f128},
};
use span::{Edition, TextSize};
use stdx::format_to;
use syntax::{AstNode, AstToken, Direction, SyntaxToken, T, algo, ast, match_ast};

use crate::{
    HoverAction, HoverConfig, HoverResult, Markup, MemoryLayoutHoverConfig,
    MemoryLayoutHoverRenderKind,
    doc_links::{remove_links, rewrite_links},
    hover::{SubstTyLen, notable_traits, walk_and_push_ty},
    interpret::render_const_eval_error,
};

pub(super) fn type_info_of(
    sema: &Semantics<'_, RootDatabase>,
    _config: &HoverConfig<'_>,
    expr_or_pat: &Either<ast::Expr, ast::Pat>,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    let ty_info = match expr_or_pat {
        Either::Left(expr) => sema.type_of_expr(expr)?,
        Either::Right(pat) => sema.type_of_pat(pat)?,
    };
    type_info(sema, _config, ty_info, edition, display_target)
}

pub(super) fn closure_expr(
    sema: &Semantics<'_, RootDatabase>,
    config: &HoverConfig<'_>,
    c: ast::ClosureExpr,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    let TypeInfo { original, .. } = sema.type_of_expr(&c.into())?;
    closure_ty(sema, config, &TypeInfo { original, adjusted: None }, edition, display_target)
}

pub(super) fn try_expr(
    sema: &Semantics<'_, RootDatabase>,
    _config: &HoverConfig<'_>,
    try_expr: &ast::TryExpr,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    let inner_ty = sema.type_of_expr(&try_expr.expr()?)?.original;
    let mut ancestors = try_expr.syntax().ancestors();
    let mut body_ty = loop {
        let next = ancestors.next()?;
        break match_ast! {
            match next {
                ast::Fn(fn_) => sema.to_def(&fn_)?.ret_type(sema.db),
                ast::Item(__) => return None,
                ast::ClosureExpr(closure) => sema.type_of_expr(&closure.body()?)?.original,
                ast::BlockExpr(block_expr) => if matches!(block_expr.modifier(), Some(ast::BlockModifier::Async(_) | ast::BlockModifier::Try { .. } | ast::BlockModifier::Const(_))) {
                    sema.type_of_expr(&block_expr.into())?.original
                } else {
                    continue;
                },
                _ => continue,
            }
        };
    };

    if inner_ty == body_ty {
        return None;
    }

    let mut inner_ty = inner_ty;
    let mut s = "Try Target".to_owned();

    let adts = inner_ty.as_adt().zip(body_ty.as_adt());
    if let Some((hir::Adt::Enum(inner), hir::Adt::Enum(body))) = adts {
        let famous_defs = FamousDefs(sema, sema.scope(try_expr.syntax())?.krate());
        // special case for two options, there is no value in showing them
        if let Some(option_enum) = famous_defs.core_option_Option()
            && inner == option_enum
            && body == option_enum
        {
            cov_mark::hit!(hover_try_expr_opt_opt);
            return None;
        }

        // special case two results to show the error variants only
        if let Some(result_enum) = famous_defs.core_result_Result()
            && inner == result_enum
            && body == result_enum
        {
            let error_type_args =
                inner_ty.type_arguments().nth(1).zip(body_ty.type_arguments().nth(1));
            if let Some((inner, body)) = error_type_args {
                inner_ty = inner;
                body_ty = body;
                "Try Error".clone_into(&mut s);
            }
        }
    }

    let mut res = HoverResult::default();

    let mut targets: Vec<hir::ModuleDef> = Vec::new();
    let mut push_new_def = |item: hir::ModuleDef| {
        if !targets.contains(&item) {
            targets.push(item);
        }
    };
    walk_and_push_ty(sema.db, &inner_ty, &mut push_new_def);
    walk_and_push_ty(sema.db, &body_ty, &mut push_new_def);
    if let Some(actions) = HoverAction::goto_type_from_targets(sema, targets, edition) {
        res.actions.push(actions);
    }

    let inner_ty = inner_ty.display(sema.db, display_target).to_string();
    let body_ty = body_ty.display(sema.db, display_target).to_string();
    let ty_len_max = inner_ty.len().max(body_ty.len());

    let l = "Propagated as: ".len() - " Type: ".len();
    let static_text_len_diff = l as isize - s.len() as isize;
    let tpad = static_text_len_diff.max(0) as usize;
    let ppad = static_text_len_diff.min(0).unsigned_abs();

    res.markup = format!(
        "```text\n{} Type: {:>pad0$}\nPropagated as: {:>pad1$}\n```\n",
        s,
        inner_ty,
        body_ty,
        pad0 = ty_len_max + tpad,
        pad1 = ty_len_max + ppad,
    )
    .into();
    Some(res)
}

pub(super) fn deref_expr(
    sema: &Semantics<'_, RootDatabase>,
    _config: &HoverConfig<'_>,
    deref_expr: &ast::PrefixExpr,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    let inner_ty = sema.type_of_expr(&deref_expr.expr()?)?.original;
    let TypeInfo { original, adjusted } =
        sema.type_of_expr(&ast::Expr::from(deref_expr.clone()))?;

    let mut res = HoverResult::default();
    let mut targets: Vec<hir::ModuleDef> = Vec::new();
    let mut push_new_def = |item: hir::ModuleDef| {
        if !targets.contains(&item) {
            targets.push(item);
        }
    };
    walk_and_push_ty(sema.db, &inner_ty, &mut push_new_def);
    walk_and_push_ty(sema.db, &original, &mut push_new_def);

    res.markup = if let Some(adjusted_ty) = adjusted {
        walk_and_push_ty(sema.db, &adjusted_ty, &mut push_new_def);
        let original = original.display(sema.db, display_target).to_string();
        let adjusted = adjusted_ty.display(sema.db, display_target).to_string();
        let inner = inner_ty.display(sema.db, display_target).to_string();
        let type_len = "To type: ".len();
        let coerced_len = "Coerced to: ".len();
        let deref_len = "Dereferenced from: ".len();
        let max_len = (original.len() + type_len)
            .max(adjusted.len() + coerced_len)
            .max(inner.len() + deref_len);
        format!(
            "```text\nDereferenced from: {:>ipad$}\nTo type: {:>apad$}\nCoerced to: {:>opad$}\n```\n",
            inner,
            original,
            adjusted,
            ipad = max_len - deref_len,
            apad = max_len - type_len,
            opad = max_len - coerced_len,
        )
        .into()
    } else {
        let original = original.display(sema.db, display_target).to_string();
        let inner = inner_ty.display(sema.db, display_target).to_string();
        let type_len = "To type: ".len();
        let deref_len = "Dereferenced from: ".len();
        let max_len = (original.len() + type_len).max(inner.len() + deref_len);
        format!(
            "```text\nDereferenced from: {:>ipad$}\nTo type: {:>apad$}\n```\n",
            inner,
            original,
            ipad = max_len - deref_len,
            apad = max_len - type_len,
        )
        .into()
    };
    if let Some(actions) = HoverAction::goto_type_from_targets(sema, targets, edition) {
        res.actions.push(actions);
    }

    Some(res)
}

pub(super) fn underscore(
    sema: &Semantics<'_, RootDatabase>,
    config: &HoverConfig<'_>,
    token: &SyntaxToken,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    if token.kind() != T![_] {
        return None;
    }
    let parent = token.parent()?;
    match_ast! {
        match parent {
            ast::InferType(it) => type_info(sema, config, TypeInfo { original: sema.resolve_type(&ast::Type::InferType(it))?, adjusted: None}, edition, display_target),
            ast::UnderscoreExpr(it) => type_info(sema, config, sema.type_of_expr(&ast::Expr::UnderscoreExpr(it))?, edition, display_target),
            ast::WildcardPat(it) => type_info(sema, config, sema.type_of_pat(&ast::Pat::WildcardPat(it))?, edition, display_target),
            _ => None,
        }
    }
}

pub(super) fn keyword(
    sema: &Semantics<'_, RootDatabase>,
    config: &HoverConfig<'_>,
    token: &SyntaxToken,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    if !token.kind().is_keyword(edition) || !config.documentation || !config.keywords {
        return None;
    }
    let parent = token.parent()?;
    let famous_defs = FamousDefs(sema, sema.scope(&parent)?.krate());

    let KeywordHint { description, keyword_mod, actions } =
        keyword_hints(sema, token, parent, edition, display_target);

    let doc_owner = find_std_module(&famous_defs, &keyword_mod, edition)?;
    let docs = doc_owner.docs_with_rangemap(sema.db)?;
    let (markup, range_map) =
        markup(Some(Either::Left(docs)), description, None, None, String::new());
    let markup = process_markup(sema.db, Definition::Module(doc_owner), &markup, range_map, config);
    Some(HoverResult { markup, actions })
}

/// Returns missing types in a record pattern.
/// Only makes sense when there's a rest pattern in the record pattern.
/// i.e. `let S {a, ..} = S {a: 1, b: 2}`
pub(super) fn struct_rest_pat(
    sema: &Semantics<'_, RootDatabase>,
    _config: &HoverConfig<'_>,
    pattern: &ast::RecordPat,
    edition: Edition,
    display_target: DisplayTarget,
) -> HoverResult {
    let matched_fields = sema.record_pattern_matched_fields(pattern);

    // if there are no matched fields, the end result is a hover that shows ".."
    // should be left in to indicate that there are no more fields in the pattern
    // example, S {a: 1, b: 2, ..} when struct S {a: u32, b: u32}

    let mut res = HoverResult::default();
    let mut targets: Vec<hir::ModuleDef> = Vec::new();
    let mut push_new_def = |item: hir::ModuleDef| {
        if !targets.contains(&item) {
            targets.push(item);
        }
    };
    for (_, t) in &matched_fields {
        walk_and_push_ty(sema.db, t, &mut push_new_def);
    }

    res.markup = {
        let mut s = String::from(".., ");
        for (f, _) in &matched_fields {
            s += f.display(sema.db, display_target).to_string().as_ref();
            s += ", ";
        }
        // get rid of trailing comma
        s.truncate(s.len() - 2);

        Markup::fenced_block(&s)
    };
    if let Some(actions) = HoverAction::goto_type_from_targets(sema, targets, edition) {
        res.actions.push(actions);
    }
    res
}

pub(super) fn try_for_lint(attr: &ast::Attr, token: &SyntaxToken) -> Option<HoverResult> {
    let (path, tt) = attr.as_simple_call()?;
    if !tt.syntax().text_range().contains(token.text_range().start()) {
        return None;
    }
    let (is_clippy, lints) = match &*path {
        "feature" => (false, FEATURES),
        "allow" | "deny" | "expect" | "forbid" | "warn" => {
            let is_clippy = algo::non_trivia_sibling(token.clone().into(), Direction::Prev)
                .filter(|t| t.kind() == T![:])
                .and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
                .filter(|t| t.kind() == T![:])
                .and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
                .is_some_and(|t| {
                    t.kind() == T![ident] && t.into_token().is_some_and(|t| t.text() == "clippy")
                });
            if is_clippy { (true, CLIPPY_LINTS) } else { (false, DEFAULT_LINTS) }
        }
        _ => return None,
    };

    let needle = if is_clippy { &format!("clippy::{}", token.text()) } else { token.text() };

    let lint =
        lints.binary_search_by_key(&needle, |lint| lint.label).ok().map(|idx| &lints[idx])?;
    Some(HoverResult {
        markup: Markup::from(format!("```\n{}\n```\n---\n\n{}", lint.label, lint.description)),
        ..Default::default()
    })
}

pub(super) fn process_markup(
    db: &RootDatabase,
    def: Definition<'_>,
    markup: &Markup,
    markup_range_map: Option<hir::Docs>,
    config: &HoverConfig<'_>,
) -> Markup {
    let markup = markup.as_str();
    let markup = if config.links_in_hover {
        rewrite_links(db, markup, def, markup_range_map.as_ref())
    } else {
        remove_links(markup)
    };
    Markup::from(markup)
}

fn definition_owner_name(
    db: &RootDatabase,
    def: Definition<'_>,
    edition: Edition,
) -> Option<String> {
    match def {
        Definition::Field(f) => {
            let parent = f.parent_def(db);
            let parent_name = parent.name(db);
            let parent_name = parent_name.display(db, edition).to_string();
            return match parent {
                Variant::EnumVariant(variant) => {
                    let enum_name = variant.parent_enum(db).name(db);
                    Some(format!("{}::{parent_name}", enum_name.display(db, edition)))
                }
                _ => Some(parent_name),
            };
        }
        Definition::EnumVariant(e) => Some(e.parent_enum(db).name(db)),
        Definition::GenericParam(generic_param) => match generic_param.parent() {
            hir::GenericDef::Adt(it) => Some(it.name(db)),
            hir::GenericDef::Trait(it) => Some(it.name(db)),
            hir::GenericDef::TypeAlias(it) => Some(it.name(db)),

            hir::GenericDef::Impl(i) => i.self_ty(db).as_adt().map(|adt| adt.name(db)),
            hir::GenericDef::Function(it) => {
                let container = it.as_assoc_item(db).and_then(|assoc| match assoc.container(db) {
                    hir::AssocItemContainer::Trait(t) => Some(t.name(db)),
                    hir::AssocItemContainer::Impl(i) => {
                        i.self_ty(db).as_adt().map(|adt| adt.name(db))
                    }
                });
                match container {
                    Some(name) => {
                        return Some(format!(
                            "{}::{}",
                            name.display(db, edition),
                            it.name(db).display(db, edition)
                        ));
                    }
                    None => Some(it.name(db)),
                }
            }
            hir::GenericDef::Const(it) => {
                let container = it.as_assoc_item(db).and_then(|assoc| match assoc.container(db) {
                    hir::AssocItemContainer::Trait(t) => Some(t.name(db)),
                    hir::AssocItemContainer::Impl(i) => {
                        i.self_ty(db).as_adt().map(|adt| adt.name(db))
                    }
                });
                match container {
                    Some(name) => {
                        return Some(format!(
                            "{}::{}",
                            name.display(db, edition),
                            it.name(db)?.display(db, edition)
                        ));
                    }
                    None => it.name(db),
                }
            }
            hir::GenericDef::Static(it) => Some(it.name(db)),
        },
        Definition::DeriveHelper(derive_helper) => Some(derive_helper.derive().name(db)),
        d => {
            if let Some(assoc_item) = d.as_assoc_item(db) {
                match assoc_item.container(db) {
                    hir::AssocItemContainer::Trait(t) => Some(t.name(db)),
                    hir::AssocItemContainer::Impl(i) => {
                        i.self_ty(db).as_adt().map(|adt| adt.name(db))
                    }
                }
            } else {
                return d.as_extern_assoc_item(db).map(|_| "<extern>".to_owned());
            }
        }
    }
    .map(|name| name.display(db, edition).to_string())
}

pub(super) fn path(
    db: &RootDatabase,
    module: hir::Module,
    item_name: Option<String>,
    edition: Edition,
) -> String {
    let crate_name = module.krate(db).display_name(db).as_ref().map(|it| it.to_string());
    let module_path = module.path_segments(db).map(|it| it.display(db, edition).to_string());
    crate_name.into_iter().chain(module_path).chain(item_name).join("::")
}

pub(super) fn definition(
    db: &RootDatabase,
    def: Definition<'_>,
    famous_defs: Option<&FamousDefs<'_, '_>>,
    notable_traits: &[(Trait, Vec<(Option<Type<'_>>, Name)>)],
    macro_arm: Option<u32>,
    render_extras: bool,
    render_private_fields: bool,
    subst_types: Option<&Vec<(Symbol, Type<'_>)>>,
    config: &HoverConfig<'_>,
    edition: Edition,
    display_target: DisplayTarget,
) -> (Markup, Option<hir::Docs>) {
    let mod_path = definition_path(db, &def, edition);
    let label = match def {
        Definition::Trait(trait_) => trait_
            .display_limited(db, config.max_trait_assoc_items_count, display_target)
            .with_private_fields(render_private_fields)
            .to_string(),
        Definition::Adt(adt @ (Adt::Struct(_) | Adt::Union(_))) => adt
            .display_limited(db, config.max_fields_count, display_target)
            .with_private_fields(render_private_fields)
            .to_string(),
        Definition::EnumVariant(variant) => variant
            .display_limited(db, config.max_fields_count, display_target)
            .with_private_fields(render_private_fields)
            .to_string(),
        Definition::Adt(adt @ Adt::Enum(_)) => adt
            .display_limited(db, config.max_enum_variants_count, display_target)
            .with_private_fields(render_private_fields)
            .to_string(),
        Definition::SelfType(impl_def) => {
            let self_ty = &impl_def.self_ty(db);
            match self_ty.as_adt() {
                Some(adt) => adt
                    .display_limited(db, config.max_fields_count, display_target)
                    .with_private_fields(render_private_fields)
                    .to_string(),
                None => self_ty.display(db, display_target).to_string(),
            }
        }
        Definition::Macro(it) => {
            let mut label = it.display(db, display_target).to_string();
            if let Some(macro_arm) = macro_arm {
                format_to!(label, " // matched arm #{}", macro_arm);
            }
            label
        }
        Definition::Function(fn_) => {
            fn_.display_with_container_bounds(db, true, display_target).to_string()
        }
        _ => def.label(db, display_target),
    };
    let docs = if config.documentation {
        def.docs_with_rangemap(db, famous_defs, display_target)
    } else {
        None
    };
    let value = || match def {
        Definition::EnumVariant(it) => {
            if !it.parent_enum(db).is_data_carrying(db) {
                match it.eval(db) {
                    Ok(it) => {
                        Some(if it >= 10 { format!("{it} ({it:#X})") } else { format!("{it}") })
                    }
                    Err(err) => {
                        let res = it.value(db).map(|it| format!("{it:?}"));
                        if env::var_os("RA_DEV").is_some() {
                            let res = res.as_deref().unwrap_or("");
                            Some(format!(
                                "{res} ({})",
                                render_const_eval_error(db, err, display_target)
                            ))
                        } else {
                            res
                        }
                    }
                }
            } else {
                None
            }
        }
        Definition::Const(it) => {
            let body = it.eval(db);
            Some(match body {
                Ok(it) => match it.render_debug(db) {
                    Ok(rendered) if rendered.is_empty() => it.render(db, display_target),
                    Ok(rendered) => rendered,
                    Err(err) => {
                        let it = it.render(db, display_target);
                        if env::var_os("RA_DEV").is_some() {
                            format!(
                                "{it}\n{}",
                                render_const_eval_error(db, err.into(), display_target)
                            )
                        } else {
                            it
                        }
                    }
                },
                Err(err) => {
                    let source = it.source(db)?;
                    let mut body = source.value.body()?.syntax().clone();
                    if let Some(macro_file) = source.file_id.macro_file() {
                        let span_map = macro_file.expansion_span_map(db);
                        body = prettify_macro_expansion(db, body, span_map, it.krate(db).into());
                    }
                    if env::var_os("RA_DEV").is_some() {
                        format!("{body}\n{}", render_const_eval_error(db, err, display_target))
                    } else {
                        body.to_string()
                    }
                }
            })
        }
        Definition::Static(it) => {
            let body = it.eval(db);
            Some(match body {
                Ok(it) => match it.render_debug(db) {
                    Ok(rendered) if rendered.is_empty() => it.render(db, display_target),
                    Ok(rendered) => rendered,

                    Err(err) => {
                        let it = it.render(db, display_target);
                        if env::var_os("RA_DEV").is_some() {
                            format!(
                                "{it}\n{}",
                                render_const_eval_error(db, err.into(), display_target)
                            )
                        } else {
                            it
                        }
                    }
                },
                Err(err) => {
                    let source = it.source(db)?;
                    let mut body = source.value.body()?.syntax().clone();
                    if let Some(macro_file) = source.file_id.macro_file() {
                        let span_map = macro_file.expansion_span_map(db);
                        body = prettify_macro_expansion(db, body, span_map, it.krate(db).into());
                    }
                    if env::var_os("RA_DEV").is_some() {
                        format!("{body}\n{}", render_const_eval_error(db, err, display_target))
                    } else {
                        body.to_string()
                    }
                }
            })
        }
        _ => None,
    };

    let layout_info = || match def {
        Definition::Field(it) => render_memory_layout(
            config.memory_layout,
            || it.layout(db),
            |_| {
                let var_def = it.parent_def(db);
                match var_def {
                    hir::Variant::Struct(s) => {
                        Adt::from(s).layout(db).ok().and_then(|layout| layout.field_offset(it))
                    }
                    _ => None,
                }
            },
            |_| None,
            |_| None,
        ),
        Definition::Adt(it @ Adt::Struct(strukt)) => render_memory_layout(
            config.memory_layout,
            || it.layout(db),
            |_| None,
            |layout| {
                let mut field_size =
                    |i: usize| Some(strukt.fields(db).get(i)?.layout(db).ok()?.size());
                if strukt.repr(db).is_some_and(|it| it.inhibit_struct_field_reordering()) {
                    Some(("tail padding", layout.tail_padding(&mut field_size)?))
                } else {
                    Some(("largest padding", layout.largest_padding(&mut field_size)?))
                }
            },
            |_| None,
        ),
        Definition::Adt(it) => render_memory_layout(
            config.memory_layout,
            || it.layout(db),
            |_| None,
            |_| None,
            |_| None,
        ),
        Definition::EnumVariant(it) => render_memory_layout(
            config.memory_layout,
            || it.layout(db),
            |_| None,
            |_| None,
            |layout| layout.enum_tag_size(),
        ),
        Definition::TypeAlias(it) => render_memory_layout(
            config.memory_layout,
            || it.ty(db).layout(db),
            |_| None,
            |_| None,
            |_| None,
        ),
        Definition::Local(it) => render_memory_layout(
            config.memory_layout,
            || it.ty(db).layout(db),
            |_| None,
            |_| None,
            |_| None,
        ),
        Definition::SelfType(it) => render_memory_layout(
            config.memory_layout,
            || it.self_ty(db).layout(db),
            |_| None,
            |_| None,
            |_| None,
        ),
        _ => None,
    };

    let drop_info = || {
        if !config.show_drop_glue {
            return None;
        }
        let drop_info = match def {
            Definition::Field(field) => {
                DropInfo { drop_glue: field.ty(db).drop_glue(db), has_dtor: None }
            }
            Definition::Adt(Adt::Struct(strukt)) => {
                let struct_drop_glue = strukt.ty(db).drop_glue(db);
                let mut fields_drop_glue = strukt
                    .fields(db)
                    .iter()
                    .map(|field| field.ty(db).drop_glue(db))
                    .max()
                    .unwrap_or(DropGlue::None);
                let has_dtor = match (fields_drop_glue, struct_drop_glue) {
                    (DropGlue::None, _) => struct_drop_glue != DropGlue::None,
                    (_, DropGlue::None) => {
                        // This is `ManuallyDrop`.
                        fields_drop_glue = DropGlue::None;
                        false
                    }
                    (_, _) => struct_drop_glue > fields_drop_glue,
                };
                DropInfo { drop_glue: fields_drop_glue, has_dtor: Some(has_dtor) }
            }
            // Unions cannot have fields with drop glue.
            Definition::Adt(Adt::Union(union)) => DropInfo {
                drop_glue: DropGlue::None,
                has_dtor: Some(union.ty(db).drop_glue(db) != DropGlue::None),
            },
            Definition::Adt(Adt::Enum(enum_)) => {
                let enum_drop_glue = enum_.ty(db).drop_glue(db);
                let fields_drop_glue = enum_
                    .variants(db)
                    .iter()
                    .map(|variant| {
                        variant
                            .fields(db)
                            .iter()
                            .map(|field| field.ty(db).drop_glue(db))
                            .max()
                            .unwrap_or(DropGlue::None)
                    })
                    .max()
                    .unwrap_or(DropGlue::None);
                DropInfo {
                    drop_glue: fields_drop_glue,
                    has_dtor: Some(enum_drop_glue > fields_drop_glue),
                }
            }
            Definition::EnumVariant(variant) => {
                let fields_drop_glue = variant
                    .fields(db)
                    .iter()
                    .map(|field| field.ty(db).drop_glue(db))
                    .max()
                    .unwrap_or(DropGlue::None);
                DropInfo { drop_glue: fields_drop_glue, has_dtor: None }
            }
            Definition::TypeAlias(type_alias) => {
                DropInfo { drop_glue: type_alias.ty(db).drop_glue(db), has_dtor: None }
            }
            Definition::Local(local) => {
                DropInfo { drop_glue: local.ty(db).drop_glue(db), has_dtor: None }
            }
            _ => return None,
        };
        let rendered_drop_glue = if drop_info.has_dtor == Some(true) {
            "impl Drop"
        } else {
            match drop_info.drop_glue {
                DropGlue::HasDropGlue => "needs Drop",
                DropGlue::None => "no Drop",
                DropGlue::DependOnParams => "type param may need Drop",
            }
        };

        Some(rendered_drop_glue.to_owned())
    };

    let dyn_compatibility_info = || match def {
        Definition::Trait(it) => {
            let mut dyn_compatibility_info = String::new();
            render_dyn_compatibility(db, &mut dyn_compatibility_info, it.dyn_compatibility(db));
            Some(dyn_compatibility_info)
        }
        _ => None,
    };

    let variance_info = || match def {
        Definition::GenericParam(it) => it.variance(db).as_ref().map(ToString::to_string),
        _ => None,
    };

    let mut extra = String::new();
    if render_extras {
        if let Some(notable_traits) =
            render_notable_trait(db, notable_traits, edition, display_target)
        {
            extra.push_str("\n___\n");
            extra.push_str(&notable_traits);
        }
        if let Some(variance_info) = variance_info() {
            extra.push_str("\n___\n");
            extra.push_str(&variance_info);
        }
        if let Some(layout_info) = layout_info() {
            extra.push_str("\n___\n");
            extra.push_str(&layout_info);
            if let Some(drop_info) = drop_info() {
                extra.push_str(", ");
                extra.push_str(&drop_info)
            }
        } else if let Some(drop_info) = drop_info() {
            extra.push_str("\n___\n");
            extra.push_str(&drop_info);
        }
        if let Some(dyn_compatibility_info) = dyn_compatibility_info() {
            extra.push_str("\n___\n");
            extra.push_str(&dyn_compatibility_info);
        }
    }
    let mut desc = String::new();
    desc.push_str(&label);
    if let Some(value) = value() {
        desc.push_str(" = ");
        desc.push_str(&value);
    }

    let subst_types = match config.max_subst_ty_len {
        SubstTyLen::Hide => String::new(),
        SubstTyLen::LimitTo(_) | SubstTyLen::Unlimited => {
            let limit = if let SubstTyLen::LimitTo(limit) = config.max_subst_ty_len {
                Some(limit)
            } else {
                None
            };
            subst_types
                .map(|subst_type| {
                    subst_type
                        .iter()
                        .filter(|(_, ty)| !ty.is_unknown())
                        .format_with(", ", |(name, ty), fmt| {
                            fmt(&format_args!(
                                "`{name}` = `{}`",
                                ty.display_truncated(db, limit, display_target)
                            ))
                        })
                        .to_string()
                })
                .unwrap_or_default()
        }
    };

    markup(docs, desc, extra.is_empty().not().then_some(extra), mod_path, subst_types)
}

#[derive(Debug)]
struct DropInfo {
    drop_glue: DropGlue,
    has_dtor: Option<bool>,
}

pub(super) fn literal(
    sema: &Semantics<'_, RootDatabase>,
    token: SyntaxToken,
    display_target: DisplayTarget,
) -> Option<Markup> {
    let lit = token.parent().and_then(ast::Literal::cast)?;
    let ty = if let Some(p) = lit.syntax().parent().and_then(ast::Pat::cast) {
        sema.type_of_pat(&p)?
    } else {
        sema.type_of_expr(&ast::Expr::Literal(lit))?
    }
    .original;

    let value = match_ast! {
        match token {
            ast::String(string)     => string.value().as_ref().map_err(|e| format!("{e:?}")).map(ToString::to_string),
            ast::ByteString(string) => string.value().as_ref().map_err(|e| format!("{e:?}")).map(|it| format!("{it:?}")),
            ast::CString(string)    => string.value().as_ref().map_err(|e| format!("{e:?}")).map(|it| std::str::from_utf8(it).map_or_else(|e| format!("{e:?}"), ToOwned::to_owned)),
            ast::Char(char)         => char  .value().as_ref().map_err(|e| format!("{e:?}")).map(ToString::to_string),
            ast::Byte(byte)         => byte  .value().as_ref().map_err(|e| format!("{e:?}")).map(|it| format!("0x{it:X}")),
            ast::FloatNumber(num) => {
                let text = num.value_string();
                if ty.as_builtin().map(|it| it.is_f16()).unwrap_or(false) {
                    match text.parse::<f16>() {
                        Ok(num) => Ok(format!("{num} (bits: 0x{:X})", num.to_bits())),
                        Err(e) => Err(e.0.to_owned()),
                    }
                } else if ty.as_builtin().map(|it| it.is_f32()).unwrap_or(false) {
                    match text.parse::<f32>() {
                        Ok(num) => Ok(format!("{num} (bits: 0x{:X})", num.to_bits())),
                        Err(e) => Err(e.to_string()),
                    }
                } else if ty.as_builtin().map(|it| it.is_f128()).unwrap_or(false) {
                    match text.parse::<f128>() {
                        Ok(num) => Ok(format!("{num} (bits: 0x{:X})", num.to_bits())),
                        Err(e) => Err(e.0.to_owned()),
                    }
                } else {
                    match text.parse::<f64>() {
                        Ok(num) => Ok(format!("{num} (bits: 0x{:X})", num.to_bits())),
                        Err(e) => Err(e.to_string()),
                    }
                }
            },
            ast::IntNumber(num) => match num.value() {
                Ok(num) => Ok(format!("{num} (0x{num:X}|0b{num:b})")),
                Err(e) => Err(e.to_string()),
            },
            _ => return None
        }
    };
    let ty = ty.display(sema.db, display_target);

    let mut s = format!("```rust\n{ty}\n```\n---\n\n");
    match value {
        Ok(value) => {
            let backtick_len = value.chars().filter(|c| *c == '`').count();
            let spaces_len = value.chars().filter(|c| *c == ' ').count();
            let backticks = "`".repeat(backtick_len + 1);
            let space_char = if spaces_len == value.len() { "" } else { " " };

            if let Some(newline) = value.find('\n') {
                format_to!(
                    s,
                    "value of literal (truncated up to newline): {backticks}{space_char}{}{space_char}{backticks}",
                    &value[..newline]
                )
            } else {
                format_to!(
                    s,
                    "value of literal: {backticks}{space_char}{value}{space_char}{backticks}"
                )
            }
        }
        Err(error) => format_to!(s, "invalid literal: {error}"),
    }
    Some(s.into())
}

fn render_notable_trait(
    db: &RootDatabase,
    notable_traits: &[(Trait, Vec<(Option<Type<'_>>, Name)>)],
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<String> {
    let mut desc = String::new();
    let mut needs_impl_header = true;
    for (trait_, assoc_types) in notable_traits {
        desc.push_str(if mem::take(&mut needs_impl_header) {
            "Implements notable traits: `"
        } else {
            "`, `"
        });
        format_to!(desc, "{}", trait_.name(db).display(db, edition));
        if !assoc_types.is_empty() {
            desc.push('<');
            format_to!(
                desc,
                "{}",
                assoc_types.iter().format_with(", ", |(ty, name), f| {
                    f(&name.display(db, edition))?;
                    f(&" = ")?;
                    match ty {
                        Some(ty) => f(&ty.display(db, display_target)),
                        None => f(&"?"),
                    }
                })
            );
            desc.push('>');
        }
    }
    if desc.is_empty() {
        None
    } else {
        desc.push('`');
        Some(desc)
    }
}

fn type_info(
    sema: &Semantics<'_, RootDatabase>,
    config: &HoverConfig<'_>,
    ty: TypeInfo<'_>,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    if let Some(res) = closure_ty(sema, config, &ty, edition, display_target) {
        return Some(res);
    };
    let db = sema.db;
    let TypeInfo { original, adjusted } = ty;
    let mut res = HoverResult::default();
    let mut targets: Vec<hir::ModuleDef> = Vec::new();
    let mut push_new_def = |item: hir::ModuleDef| {
        if !targets.contains(&item) {
            targets.push(item);
        }
    };
    walk_and_push_ty(db, &original, &mut push_new_def);

    res.markup = if let Some(adjusted_ty) = adjusted {
        walk_and_push_ty(db, &adjusted_ty, &mut push_new_def);

        let notable = if let Some(notable) =
            render_notable_trait(db, &notable_traits(db, &original), edition, display_target)
        {
            format!("{notable}\n")
        } else {
            String::new()
        };

        let original = original.display(db, display_target).to_string();
        let adjusted = adjusted_ty.display(db, display_target).to_string();
        let static_text_diff_len = "Coerced to: ".len() - "Type: ".len();
        format!(
            "```text\nType: {:>apad$}\nCoerced to: {:>opad$}\n{notable}```\n",
            original,
            adjusted,
            apad = static_text_diff_len + adjusted.len().max(original.len()),
            opad = original.len(),
        )
        .into()
    } else {
        let mut desc = format!("```rust\n{}\n```", original.display(db, display_target));
        if let Some(extra) =
            render_notable_trait(db, &notable_traits(db, &original), edition, display_target)
        {
            desc.push_str("\n---\n");
            desc.push_str(&extra);
        };
        desc.into()
    };
    if let Some(actions) = HoverAction::goto_type_from_targets(sema, targets, edition) {
        res.actions.push(actions);
    }
    Some(res)
}

fn closure_ty(
    sema: &Semantics<'_, RootDatabase>,
    config: &HoverConfig<'_>,
    TypeInfo { original, adjusted }: &TypeInfo<'_>,
    edition: Edition,
    display_target: DisplayTarget,
) -> Option<HoverResult> {
    let c = original.as_closure()?;
    let captures = c.captured_items(sema.db);
    let mut captures_rendered = captures
        .iter()
        .map(|it| {
            let borrow_kind = match it.kind() {
                CaptureKind::SharedRef => "immutable borrow",
                CaptureKind::UniqueSharedRef => "unique immutable borrow ([read more](https://doc.rust-lang.org/stable/reference/types/closure.html#unique-immutable-borrows-in-captures))",
                CaptureKind::MutableRef => "mutable borrow",
                CaptureKind::Move => "move",
            };
            format!("* `{}` by {}", it.display_place_source_code(sema.db, display_target.edition), borrow_kind)
        })
        .join("\n");
    if captures_rendered.trim().is_empty() {
        "This closure captures nothing".clone_into(&mut captures_rendered);
    }
    let mut targets: Vec<hir::ModuleDef> = Vec::new();
    let mut push_new_def = |item: hir::ModuleDef| {
        if !targets.contains(&item) {
            targets.push(item);
        }
    };
    walk_and_push_ty(sema.db, original, &mut push_new_def);
    captures.iter().for_each(|capture| {
        walk_and_push_ty(sema.db, &capture.ty(sema.db), &mut push_new_def);
    });

    let adjusted = if let Some(adjusted_ty) = adjusted {
        walk_and_push_ty(sema.db, adjusted_ty, &mut push_new_def);
        format!(
            "\nCoerced to: {}",
            adjusted_ty
                .display(sema.db, display_target)
                .with_closure_style(hir::ClosureStyle::ImplFn)
        )
    } else {
        String::new()
    };
    let mut markup = format!("```rust\n{}\n```", c.display_with_impl(sema.db, display_target));

    if let Some(trait_) = c.fn_trait(sema.db).get_id(sema.db, original.krate(sema.db)) {
        push_new_def(trait_.into())
    }
    if let Some(layout) = render_memory_layout(
        config.memory_layout,
        || original.layout(sema.db),
        |_| None,
        |_| None,
        |_| None,
    ) {
        format_to!(markup, "\n---\n{layout}");
    }
    format_to!(markup, "{adjusted}\n\n## Captures\n{}", captures_rendered,);

    let mut res = HoverResult::default();
    if let Some(actions) = HoverAction::goto_type_from_targets(sema, targets, edition) {
        res.actions.push(actions);
    }
    res.markup = markup.into();
    Some(res)
}

fn definition_path(db: &RootDatabase, &def: &Definition<'_>, edition: Edition) -> Option<String> {
    if matches!(
        def,
        Definition::TupleField(_)
            | Definition::Label(_)
            | Definition::Local(_)
            | Definition::BuiltinAttr(_)
            | Definition::BuiltinLifetime(_)
            | Definition::BuiltinType(_)
            | Definition::InlineAsmRegOrRegClass(_)
            | Definition::InlineAsmOperand(_)
    ) {
        return None;
    }
    let rendered_parent = definition_owner_name(db, def, edition);
    def.module(db).map(|module| path(db, module, rendered_parent, edition))
}

fn markup(
    docs: Option<Either<Cow<'_, hir::Docs>, Documentation<'_>>>,
    rust: String,
    extra: Option<String>,
    mod_path: Option<String>,
    subst_types: String,
) -> (Markup, Option<hir::Docs>) {
    let mut buf = String::new();

    if let Some(mod_path) = mod_path
        && !mod_path.is_empty()
    {
        format_to!(buf, "```rust\n{}\n```\n\n", mod_path);
    }
    format_to!(buf, "```rust\n{}\n```", rust);

    if let Some(extra) = extra {
        buf.push_str(&extra);
    }

    if !subst_types.is_empty() {
        format_to!(buf, "\n___\n{subst_types}");
    }

    if let Some(doc) = docs {
        format_to!(buf, "\n___\n\n");
        let offset = TextSize::new(buf.len() as u32);
        let docs_str = match &doc {
            Either::Left(docs) => docs.docs(),
            Either::Right(docs) => docs.as_str(),
        };
        format_to!(buf, "{}", docs_str);
        let range_map = match doc {
            Either::Left(range_map) => {
                let mut range_map = range_map.into_owned();
                range_map.shift_by(offset);
                Some(range_map)
            }
            Either::Right(_) => None,
        };

        (buf.into(), range_map)
    } else {
        (buf.into(), None)
    }
}

fn render_memory_layout<'db>(
    config: Option<MemoryLayoutHoverConfig>,
    layout: impl FnOnce() -> Result<Layout<'db>, LayoutError>,
    offset: impl FnOnce(&Layout<'db>) -> Option<u64>,
    padding: impl for<'a> FnOnce(&'a Layout<'db>) -> Option<(&'a str, u64)>,
    tag: impl FnOnce(&Layout<'db>) -> Option<usize>,
) -> Option<String> {
    let config = config?;
    let layout = layout().ok()?;

    let mut label = String::new();

    if let Some(render) = config.size {
        let size = match tag(&layout) {
            Some(tag) => layout.size() as usize - tag,
            None => layout.size() as usize,
        };
        format_to!(label, "size = ");
        match render {
            MemoryLayoutHoverRenderKind::Decimal => format_to!(label, "{size}"),
            MemoryLayoutHoverRenderKind::Hexadecimal => format_to!(label, "{size:#X}"),
            MemoryLayoutHoverRenderKind::Both if size >= 10 => {
                format_to!(label, "{size} ({size:#X})")
            }
            MemoryLayoutHoverRenderKind::Both => format_to!(label, "{size}"),
        }
        format_to!(label, ", ");
    }

    if let Some(render) = config.alignment {
        let align = layout.align();
        format_to!(label, "align = ");
        match render {
            MemoryLayoutHoverRenderKind::Decimal => format_to!(label, "{align}",),
            MemoryLayoutHoverRenderKind::Hexadecimal => format_to!(label, "{align:#X}",),
            MemoryLayoutHoverRenderKind::Both if align >= 10 => {
                format_to!(label, "{align} ({align:#X})")
            }
            MemoryLayoutHoverRenderKind::Both => {
                format_to!(label, "{align}")
            }
        }
        format_to!(label, ", ");
    }

    if let Some(render) = config.offset
        && let Some(offset) = offset(&layout)
    {
        format_to!(label, "offset = ");
        match render {
            MemoryLayoutHoverRenderKind::Decimal => format_to!(label, "{offset}"),
            MemoryLayoutHoverRenderKind::Hexadecimal => format_to!(label, "{offset:#X}"),
            MemoryLayoutHoverRenderKind::Both if offset >= 10 => {
                format_to!(label, "{offset} ({offset:#X})")
            }
            MemoryLayoutHoverRenderKind::Both => {
                format_to!(label, "{offset}")
            }
        }
        format_to!(label, ", ");
    }

    if let Some(render) = config.padding
        && let Some((padding_name, padding)) = padding(&layout)
    {
        format_to!(label, "{padding_name} = ");
        match render {
            MemoryLayoutHoverRenderKind::Decimal => format_to!(label, "{padding}"),
            MemoryLayoutHoverRenderKind::Hexadecimal => format_to!(label, "{padding:#X}"),
            MemoryLayoutHoverRenderKind::Both if padding >= 10 => {
                format_to!(label, "{padding} ({padding:#X})")
            }
            MemoryLayoutHoverRenderKind::Both => {
                format_to!(label, "{padding}")
            }
        }
        format_to!(label, ", ");
    }

    if config.niches
        && let Some(niches) = layout.niches()
    {
        if niches > 1024 {
            if niches.is_power_of_two() {
                format_to!(label, "niches = 2{}, ", pwr2_to_exponent(niches));
            } else if is_pwr2plus1(niches) {
                format_to!(label, "niches = 2{} + 1, ", pwr2_to_exponent(niches - 1));
            } else if is_pwr2minus1(niches) {
                format_to!(label, "niches = 2{} - 1, ", pwr2_to_exponent(niches + 1));
            } else {
                format_to!(label, "niches = a lot, ");
            }
        } else {
            format_to!(label, "niches = {niches}, ");
        }
    }
    label.pop(); // ' '
    label.pop(); // ','
    Some(label)
}

struct KeywordHint {
    description: String,
    keyword_mod: String,
    actions: Vec<HoverAction>,
}

impl KeywordHint {
    fn new(description: String, keyword_mod: String) -> Self {
        Self { description, keyword_mod, actions: Vec::default() }
    }
}

fn keyword_hints(
    sema: &Semantics<'_, RootDatabase>,
    token: &SyntaxToken,
    parent: syntax::SyntaxNode,
    edition: Edition,
    display_target: DisplayTarget,
) -> KeywordHint {
    match token.kind() {
        T![await] | T![loop] | T![match] | T![unsafe] | T![as] | T![try] | T![if] | T![else] => {
            let keyword_mod = format!("{}_keyword", token.text());

            match ast::Expr::cast(parent).and_then(|site| sema.type_of_expr(&site)) {
                // ignore the unit type ()
                Some(ty) if !ty.adjusted.as_ref().unwrap_or(&ty.original).is_unit() => {
                    let mut targets: Vec<hir::ModuleDef> = Vec::new();
                    let mut push_new_def = |item: hir::ModuleDef| {
                        if !targets.contains(&item) {
                            targets.push(item);
                        }
                    };
                    walk_and_push_ty(sema.db, &ty.original, &mut push_new_def);

                    let ty = ty.adjusted();
                    let description =
                        format!("{}: {}", token.text(), ty.display(sema.db, display_target));

                    KeywordHint {
                        description,
                        keyword_mod,
                        actions: HoverAction::goto_type_from_targets(sema, targets, edition)
                            .into_iter()
                            .collect(),
                    }
                }
                _ => KeywordHint {
                    description: token.text().to_owned(),
                    keyword_mod,
                    actions: Vec::new(),
                },
            }
        }
        T![fn] => {
            let module = match ast::FnPtrType::cast(parent) {
                // treat fn keyword inside function pointer type as primitive
                Some(_) => format!("prim_{}", token.text()),
                None => format!("{}_keyword", token.text()),
            };
            KeywordHint::new(token.text().to_owned(), module)
        }
        T![Self] => KeywordHint::new(token.text().to_owned(), "self_upper_keyword".into()),
        _ => KeywordHint::new(token.text().to_owned(), format!("{}_keyword", token.text())),
    }
}

fn render_dyn_compatibility(
    db: &RootDatabase,
    buf: &mut String,
    safety: Option<DynCompatibilityViolation>,
) {
    let Some(osv) = safety else {
        buf.push_str("Is dyn-compatible");
        return;
    };
    buf.push_str("Is not dyn-compatible due to ");
    match osv {
        DynCompatibilityViolation::SizedSelf => {
            buf.push_str("having a `Self: Sized` bound");
        }
        DynCompatibilityViolation::SelfReferential => {
            buf.push_str("having a bound that references `Self`");
        }
        DynCompatibilityViolation::Method(func, mvc) => {
            let name = hir::Function::from(func).name(db);
            format_to!(buf, "having a method `{}` that is not dispatchable due to ", name.as_str());
            let desc = match mvc {
                MethodViolationCode::StaticMethod => "missing a receiver",
                MethodViolationCode::ReferencesSelfInput => "having a parameter referencing `Self`",
                MethodViolationCode::ReferencesSelfOutput => "the return type referencing `Self`",
                MethodViolationCode::ReferencesImplTraitInTrait => {
                    "the return type containing `impl Trait`"
                }
                MethodViolationCode::AsyncFn => "being async",
                MethodViolationCode::WhereClauseReferencesSelf => {
                    "a where clause referencing `Self`"
                }
                MethodViolationCode::Generic => "having a const or type generic parameter",
                MethodViolationCode::UndispatchableReceiver => {
                    "having a non-dispatchable receiver type"
                }
            };
            buf.push_str(desc);
        }
        DynCompatibilityViolation::AssocConst(const_) => {
            let name = hir::Const::from(const_).name(db);
            if let Some(name) = name {
                format_to!(buf, "having an associated constant `{}`", name.as_str());
            } else {
                buf.push_str("having an associated constant");
            }
        }
        DynCompatibilityViolation::GAT(alias) => {
            let name = hir::TypeAlias::from(alias).name(db);
            format_to!(buf, "having a generic associated type `{}`", name.as_str());
        }
        DynCompatibilityViolation::HasNonCompatibleSuperTrait(super_trait) => {
            let name = hir::Trait::from(super_trait).name(db);
            format_to!(buf, "having a dyn-incompatible supertrait `{}`", name.as_str());
        }
    }
}

fn is_pwr2minus1(val: u128) -> bool {
    val == u128::MAX || (val + 1).is_power_of_two()
}

fn is_pwr2plus1(val: u128) -> bool {
    val != 0 && (val - 1).is_power_of_two()
}

/// Formats a power of two as an exponent of two, i.e. 16 => ⁴. Note that `num` MUST be a power
/// of 2, or this function will panic.
fn pwr2_to_exponent(num: u128) -> String {
    const DIGITS: [char; 10] = ['⁰', '¹', '²', '³', '⁴', '⁵', '⁶', '⁷', '⁸', '⁹'];
    assert_eq!(num.count_ones(), 1);
    num.trailing_zeros()
        .to_string()
        .chars()
        .map(|c| c.to_digit(10).unwrap() as usize)
        .map(|idx| DIGITS[idx])
        .collect::<String>()
}

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

    const TESTERS: [u128; 10] = [0, 1, 2, 3, 4, 255, 256, 257, u128::MAX - 1, u128::MAX];

    #[test]
    fn test_is_pwr2minus1() {
        const OUTCOMES: [bool; 10] =
            [true, true, false, true, false, true, false, false, false, true];
        for (test, expected) in TESTERS.iter().zip(OUTCOMES) {
            let actual = is_pwr2minus1(*test);
            assert_eq!(actual, expected, "is_pwr2minu1({test}) gave {actual}, expected {expected}");
        }
    }

    #[test]
    fn test_is_pwr2plus1() {
        const OUTCOMES: [bool; 10] =
            [false, false, true, true, false, false, false, true, false, false];
        for (test, expected) in TESTERS.iter().zip(OUTCOMES) {
            let actual = is_pwr2plus1(*test);
            assert_eq!(actual, expected, "is_pwr2plus1({test}) gave {actual}, expected {expected}");
        }
    }

    #[test]
    fn test_pwr2_to_exponent() {
        const TESTERS: [u128; 9] = [
            1,
            2,
            4,
            8,
            16,
            9223372036854775808,
            18446744073709551616,
            36893488147419103232,
            170141183460469231731687303715884105728,
        ];
        const OUTCOMES: [&str; 9] = ["⁰", "¹", "²", "³", "⁴", "⁶³", "⁶⁴", "⁶⁵", "¹²⁷"];
        for (test, expected) in TESTERS.iter().zip(OUTCOMES) {
            let actual = pwr2_to_exponent(*test);
            assert_eq!(
                actual, expected,
                "pwr2_to_exponent({test}) returned {actual}, expected {expected}",
            );
        }
    }
}