submilli_engine/runtime/prelude/string/

install.rs

//! ABI wiring for the Rust `String` methods: marshals `$string` ↔ [`Str`],
//! registers each method under its dispatch key, and declares the value symbols
//! codegen routes through. The string operations themselves live in the parent
//! module — this file is the wasmtime boundary they're kept clear of.

use crate::runtime::host::{abi_arg, abi_result};
use wasmtime::{
    ArrayRef, ArrayRefPre, ArrayType, Caller, FuncType, HeapType, Linker, RefType, Rooted,
    StructRef, StructRefPre, StructType, Val, ValType,
};

use super::gc_text::{GcText, GcUnits, Run, allocate, fill_run};
use super::transforms::{TrimEnds, to_lower_case, to_upper_case, trim_range};
use super::{
    RangeError, Str, at_index, cmp, code_point, concat_length, ends_with_window, from_char_code,
    from_code_point, includes, index_of, is_well_formed, last_index_of, normalize, pad_length,
    repeat_length, slice_range, starts_with_window, string_index_unit, substr_range,
    substring_range, to_well_formed, unit_index,
};
use crate::runtime::StoreData;
use crate::runtime::fuel;
use crate::runtime::host::{
    fatal_host_error, intrinsic_string_type, range_error, read_code_unit, read_code_units,
    read_code_units_range, register_host_fn, register_host_fn_async, string_array_type,
    write_boxed_number_struct, write_submilli_string_struct, write_submilli_string_struct_units,
};
use crate::runtime::intrinsic_types::{build_intrinsic_types, intrinsic_types};
use crate::runtime::prelude::{MODULE_NAME, declare_method};
use crate::{MangledName, PackageDeclaration, Param, Type};

/// The dispatch key codegen looks up for `String#<method>`: the prelude's
/// `String` interface mangled name extended by the method. The host fn's linker
/// field and the value symbol's mangled name must both be exactly this.
fn method_key(method: &str) -> MangledName {
    crate::mangle::extend(&crate::mangle::prelude("String"), method)
}

/// The dispatch key for a `StringConstructor` static (`String.fromCharCode`,
/// `String.fromCodePoint`) — the `StringConstructor` interface mangled name
/// extended by the method.
fn ctor_key(method: &str) -> MangledName {
    crate::mangle::extend(&crate::mangle::prelude("StringConstructor"), method)
}

pub fn install(linker: &mut Linker<StoreData>) -> wasmtime::Result<()> {
    let engine = linker.engine().clone();
    let abi = StringAbi::recover(&engine)?;

    // Accessors read the few units they need straight from the payload
    // instead of copying the whole string.
    reg_unit_to_str(linker, &engine, &abi, "charAt", unit_index)?;
    reg_string_index(linker, &engine, &abi)?;
    reg_unit_to_str_or_undefined(linker, &engine, &abi, "at", at_index)?;
    reg_char_code_at(linker, &engine, &abi)?;
    reg_code_point_at(linker, &engine, &abi)?;

    reg_range_to_str(linker, &engine, &abi, "slice", slice_range)?;
    reg_range_to_str(linker, &engine, &abi, "substring", substring_range)?;
    reg_range_to_str(linker, &engine, &abi, "substr", substr_range)?;

    reg_str_str_num_to_num(linker, &engine, &abi, "indexOf", index_of)?;
    reg_str_str_num_to_num(linker, &engine, &abi, "lastIndexOf", last_index_of)?;
    register_string_search_predicate(linker, &engine, &abi, "includes", includes)?;
    reg_window_predicate(linker, &engine, &abi, "startsWith", starts_with_window)?;
    reg_window_predicate(linker, &engine, &abi, "endsWith", ends_with_window)?;

    reg_concat(linker, &engine, &abi)?;
    reg_pad(linker, &engine, &abi, "padStart", PadSide::Start)?;
    reg_pad(linker, &engine, &abi, "padEnd", PadSide::End)?;

    reg_str_to_bool(linker, &engine, &abi, "isWellFormed", is_well_formed)?;
    reg_str_to_str(linker, &engine, &abi, "toWellFormed", to_well_formed)?;

    super::transforms::prepare_case_properties()?;
    // Closures, because a generic `fn(&mut impl Text)` is not a fn pointer for
    // every `GcText` lifetime.
    reg_case_map(linker, &engine, &abi, "toUpperCase", |text| {
        to_upper_case(text)
    })?;
    reg_case_map(linker, &engine, &abi, "toLowerCase", |text| {
        to_lower_case(text)
    })?;
    reg_trim(linker, &engine, &abi, "trim", TrimEnds::Both)?;
    reg_trim(linker, &engine, &abi, "trimStart", TrimEnds::Start)?;
    reg_trim(linker, &engine, &abi, "trimEnd", TrimEnds::End)?;
    reg_trim(linker, &engine, &abi, "trimLeft", TrimEnds::Start)?;
    reg_trim(linker, &engine, &abi, "trimRight", TrimEnds::End)?;
    reg_str_str_to_str_fallible(linker, &engine, &abi, "normalize", normalize)?;

    reg_repeat(linker, &engine, &abi)?;

    // StringConstructor statics: `Dispatch::Static`, so the receiver is dropped
    // and the variadic args arrive packed into one `$Array` of boxed numbers.
    let array_ref = ValType::Ref(RefType::new(
        false,
        HeapType::ConcreteStruct(build_intrinsic_types(&engine)?.array),
    ));
    register_host_fn(
        linker,
        MODULE_NAME,
        ctor_key("fromCharCode"),
        FuncType::new(&engine, [array_ref.clone()], [abi.value_type()]),
        true,
        move |caller, params, results| {
            let codes = read_number_array(caller, abi_arg(params, 0)?, "String.fromCharCode")?;
            let out = from_char_code(&codes);
            let st = write_submilli_string_struct_units(caller, out.units())?;
            *abi_result(results, 0)? = Val::AnyRef(Some(st.to_anyref()));
            Ok(())
        },
    )?;
    register_host_fn(
        linker,
        MODULE_NAME,
        ctor_key("fromCodePoint"),
        FuncType::new(&engine, [array_ref], [abi.value_type()]),
        true,
        move |caller, params, results| {
            let codes = read_number_array(caller, abi_arg(params, 0)?, "String.fromCodePoint")?;
            let out = from_code_point(&codes).map_err(throw)?;
            let st = write_submilli_string_struct_units(caller, out.units())?;
            *abi_result(results, 0)? = Val::AnyRef(Some(st.to_anyref()));
            Ok(())
        },
    )?;

    // Identity/serialization/comparison members (their vtable-slot twins live
    // in `vtable.rs`; these are the direct-dispatch method keys).
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("toString"),
        FuncType::new(&engine, [abi.value_type()], [abi.value_type()]),
        true,
        |_caller, params, results| {
            *abi_result(results, 0)? = *abi_arg(params, 0)?;
            Ok(())
        },
    )?;
    let json_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("toJson"),
        FuncType::new(&engine, [abi.value_type()], [abi.value_type()]),
        true,
        move |caller, params, results| {
            let recv = json_abi.read(caller, abi_arg(params, 0)?, "String#toJson")?;
            *abi_result(results, 0)? =
                crate::runtime::prelude::vtable::quote_string(caller, recv.value.units())?;
            Ok(())
        },
    )?;
    let equals_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("equals"),
        FuncType::new(
            &engine,
            [abi.value_type(), abi.value_type()],
            [ValType::I32],
        ),
        true,
        move |caller, params, results| {
            *abi_result(results, 0)? = Val::I32(super::super::vtable::string_equals(
                caller,
                abi_arg(params, 0)?,
                abi_arg(params, 1)?,
                &equals_abi.string_ty,
            )? as i32);
            Ok(())
        },
    )?;
    let lc_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("localeCompare"),
        FuncType::new(
            &engine,
            [abi.value_type(), abi.value_type()],
            [ValType::F64],
        ),
        true,
        move |caller, params, results| {
            let a = lc_abi.read(caller, abi_arg(params, 0)?, "String#localeCompare")?;
            let b = lc_abi.read(caller, abi_arg(params, 1)?, "String#localeCompare")?;
            *abi_result(results, 0)? = Val::F64(f64::from(cmp(&a.value, &b.value)).to_bits());
            Ok(())
        },
    )?;

    // `String(value)` — the conversion call-signature (`Dispatch::Static`, so
    // only the value arrives). A bigint renders its decimal text directly (its
    // vtable slots are host-owned but the Wasm path special-cased it, and the
    // dispatch is cheaper); everything else re-enters its `toString` slot.
    let obj_param = ValType::Ref(RefType::new(
        true,
        HeapType::ConcreteStruct(build_intrinsic_types(&engine)?.object),
    ));
    register_host_fn_async(
        linker,
        MODULE_NAME,
        crate::mangle::extend(&crate::mangle::prelude("StringConstructor"), "@call"),
        FuncType::new(&engine, [obj_param], [abi.value_type()]),
        true,
        |caller, params, results| {
            Box::pin(async move {
                *abi_result(results, 0)? = string_ctor_call(caller, abi_arg(params, 0)?).await?;
                Ok(())
            })
        },
    )?;

    // `String#iterator` — the for-of cursor over code points.
    let obj_ret = ValType::Ref(RefType::new(
        true,
        HeapType::ConcreteStruct(build_intrinsic_types(&engine)?.object),
    ));
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("iterator"),
        FuncType::new(&engine, [abi.value_type()], [obj_ret]),
        true,
        |caller, params, results| {
            *abi_result(results, 0)? = crate::runtime::prelude::iterator::make_string_iterator(
                caller,
                *abi_arg(params, 0)?,
            )?;
            Ok(())
        },
    )?;

    // Operator primitives — value symbols, not method keys: codegen emits
    // direct calls to these for string `+`, `===`/`==`, and relational compares.
    let s = abi.value_type();
    let concat_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        crate::mangle::prelude("string_concat"),
        FuncType::new(&engine, [s.clone(), s.clone()], [s.clone()]),
        true,
        move |caller, params, results| {
            *abi_result(results, 0)? = concat_abi.concat(
                caller,
                abi_arg(params, 0)?,
                abi_arg(params, 1)?,
                "string_concat",
            )?;
            Ok(())
        },
    )?;
    let eq_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        crate::mangle::prelude("string_eq"),
        FuncType::new(&engine, [s.clone(), s.clone()], [ValType::I32]),
        true,
        move |caller, params, results| {
            let equal = super::super::vtable::string_equals(
                caller,
                abi_arg(params, 0)?,
                abi_arg(params, 1)?,
                &eq_abi.string_ty,
            )?;
            *abi_result(results, 0)? = Val::I32(equal as i32);
            Ok(())
        },
    )?;
    let cmp_abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        crate::mangle::prelude("string_cmp"),
        FuncType::new(&engine, [s.clone(), s], [ValType::I32]),
        true,
        move |caller, params, results| {
            let a = cmp_abi.read(caller, abi_arg(params, 0)?, "string_cmp")?;
            let b = cmp_abi.read(caller, abi_arg(params, 1)?, "string_cmp")?;
            *abi_result(results, 0)? = Val::I32(cmp(&a.value, &b.value));
            Ok(())
        },
    )?;
    Ok(())
}

pub fn declare(defs: &mut PackageDeclaration) {
    let m = |defs: &mut PackageDeclaration, name: &str, params: Vec<Param>, ret: Type| {
        declare_method(defs, name, method_key(name), params, ret);
    };
    let s = || Param::new("s", Type::String);

    m(
        defs,
        "charAt",
        vec![s(), Param::new("index", Type::Number)],
        Type::String,
    );
    m(
        defs,
        "at",
        vec![s(), Param::new("index", Type::Number)],
        Type::Union(vec![Type::String, Type::Undefined]),
    );
    m(
        defs,
        "charCodeAt",
        vec![s(), Param::new("index", Type::Number)],
        Type::Number,
    );
    m(
        defs,
        "codePointAt",
        vec![s(), Param::new("index", Type::Number)],
        Type::Union(vec![Type::Number, Type::Undefined]),
    );
    m(
        defs,
        "slice",
        vec![
            s(),
            Param::new("start", Type::Number),
            Param::new("end", Type::Number),
        ],
        Type::String,
    );
    m(
        defs,
        "substring",
        vec![
            s(),
            Param::new("start", Type::Number),
            Param::new("end", Type::Number),
        ],
        Type::String,
    );
    m(
        defs,
        "substr",
        vec![
            s(),
            Param::new("start", Type::Number),
            Param::new("length", Type::Number),
        ],
        Type::String,
    );
    m(
        defs,
        "indexOf",
        vec![
            s(),
            Param::new("search", Type::String),
            Param::new("fromIndex", Type::Number),
        ],
        Type::Number,
    );
    m(
        defs,
        "lastIndexOf",
        vec![
            s(),
            Param::new("search", Type::String),
            Param::new("fromIndex", Type::Number),
        ],
        Type::Number,
    );
    m(
        defs,
        "includes",
        vec![
            s(),
            Param::new("search", Type::Unknown),
            Param::new("fromIndex", Type::Unknown),
        ],
        Type::Boolean,
    );
    m(
        defs,
        "startsWith",
        vec![
            s(),
            Param::new("search", Type::Unknown),
            Param::new("position", Type::Unknown),
        ],
        Type::Boolean,
    );
    m(
        defs,
        "endsWith",
        vec![
            s(),
            Param::new("search", Type::Unknown),
            Param::new("endPosition", Type::Unknown),
        ],
        Type::Boolean,
    );
    m(
        defs,
        "concat",
        vec![
            s(),
            Param::new("strings", Type::Array(Box::new(Type::String))),
        ],
        Type::String,
    );
    m(
        defs,
        "padStart",
        vec![
            s(),
            Param::new("targetLength", Type::Number),
            Param::new("padString", Type::String),
        ],
        Type::String,
    );
    m(
        defs,
        "padEnd",
        vec![
            s(),
            Param::new("targetLength", Type::Number),
            Param::new("padString", Type::String),
        ],
        Type::String,
    );
    m(defs, "isWellFormed", vec![s()], Type::Boolean);
    m(defs, "toWellFormed", vec![s()], Type::String);
    m(defs, "toUpperCase", vec![s()], Type::String);
    m(defs, "toLowerCase", vec![s()], Type::String);
    m(defs, "trim", vec![s()], Type::String);
    m(defs, "trimStart", vec![s()], Type::String);
    m(defs, "trimEnd", vec![s()], Type::String);
    m(defs, "trimLeft", vec![s()], Type::String);
    m(defs, "trimRight", vec![s()], Type::String);
    m(
        defs,
        "normalize",
        vec![s(), Param::new("form", Type::String)],
        Type::String,
    );
    m(
        defs,
        "repeat",
        vec![s(), Param::new("count", Type::Number)],
        Type::String,
    );

    declare_method(
        defs,
        "fromCharCode",
        ctor_key("fromCharCode"),
        vec![Param::rest("codes", Type::Array(Box::new(Type::Number)))],
        Type::String,
    );
    declare_method(
        defs,
        "fromCodePoint",
        ctor_key("fromCodePoint"),
        vec![Param::rest(
            "codePoints",
            Type::Array(Box::new(Type::Number)),
        )],
        Type::String,
    );

    m(
        defs,
        "iterator",
        vec![s()],
        Type::prelude_interface("Iterator".to_string(), vec![Type::String]),
    );
    m(defs, "toString", vec![s()], Type::String);
    m(defs, "toJson", vec![s()], Type::String);
    m(
        defs,
        "equals",
        vec![s(), Param::new("other", Type::String)],
        Type::Boolean,
    );
    m(
        defs,
        "localeCompare",
        vec![s(), Param::new("other", Type::String)],
        Type::Number,
    );
    declare_method(
        defs,
        "@call",
        crate::mangle::extend(&crate::mangle::prelude("StringConstructor"), "@call"),
        vec![Param::new("value", Type::Unknown)],
        Type::String,
    );

    // Operator primitives (value symbols; `string_cmp`'s boolean return is an
    // i32 sign, matching the prelude declaration it overrides).
    let two_strings = || vec![Param::anon(Type::String), Param::anon(Type::String)];
    declare_method(
        defs,
        "string_concat",
        crate::mangle::prelude("string_concat"),
        two_strings(),
        Type::String,
    );
    declare_method(
        defs,
        "string_eq",
        crate::mangle::prelude("string_eq"),
        two_strings(),
        Type::Boolean,
    );
    declare_method(
        defs,
        "string_cmp",
        crate::mangle::prelude("string_cmp"),
        two_strings(),
        Type::Boolean,
    );
    declare_method(
        defs,
        "string_index",
        crate::mangle::prelude("string_index"),
        vec![Param::anon(Type::String), Param::anon(Type::Number)],
        Type::String,
    );
}

/// `(string, f64) -> string`: `charAt`. `pick` names the unit for the index,
/// if any; the result is that unit or `""`.
fn reg_unit_to_str(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    pick: fn(usize, f64) -> Option<usize>,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone(), ValType::F64], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            let arg = number(abi_arg(params, 1)?, name)?;
            let unit = pick(recv.len, arg)
                .map(|i| read_code_unit(&mut *caller, recv.array, i))
                .transpose()?;
            let out = Str::from_units(unit.map_or_else(Vec::new, |unit| vec![unit]));
            *abi_result(results, 0)? = abi.write(caller, recv.vtable, &out)?;
            Ok(())
        },
    )
}

/// `(string, f64) -> string`: `s[index]`. Out of range throws the `RangeError`
/// an array read throws, rather than JavaScript's `undefined`, which the
/// `string` it is typed as can't hold.
fn reg_string_index(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        crate::mangle::prelude("string_index"),
        FuncType::new(engine, [s.clone(), ValType::F64], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, "string_index")?;
            let arg = number(abi_arg(params, 1)?, "string_index")?;
            let Some(index) = string_index_unit(recv.len, arg) else {
                return Err(range_error(crate::codegen::bounds::INDEX_OOB_MESSAGE));
            };
            let unit = read_code_unit(&mut *caller, recv.array, index)?;
            *abi_result(results, 0)? =
                abi.write(caller, recv.vtable, &Str::from_units(vec![unit]))?;
            Ok(())
        },
    )
}

/// `(string, f64) -> string | undefined`: `at`, whose out-of-range answer is `undefined`.
/// The result slot is the union lowering `(ref null $Object)`; a `$string` is an
/// `$Object` subtype, so the hit case needs no extra boxing.
fn reg_unit_to_str_or_undefined(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    pick: fn(usize, f64) -> Option<usize>,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let object = ValType::Ref(RefType::new(
        true,
        HeapType::ConcreteStruct(build_intrinsic_types(engine)?.object),
    ));
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s, ValType::F64], [object]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            let arg = number(abi_arg(params, 1)?, name)?;
            *abi_result(results, 0)? = match pick(recv.len, arg) {
                Some(i) => {
                    let unit = read_code_unit(&mut *caller, recv.array, i)?;
                    abi.write(caller, recv.vtable, &Str::from_units(vec![unit]))?
                }
                None => crate::runtime::prelude::undefined::value(caller)?,
            };
            Ok(())
        },
    )
}

/// `charCodeAt`: the code unit at the index, or `NaN` out of range.
fn reg_char_code_at(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
) -> wasmtime::Result<()> {
    const NAME: &str = "charCodeAt";
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(NAME),
        FuncType::new(engine, [s, ValType::F64], [ValType::F64]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, NAME)?;
            let arg = number(abi_arg(params, 1)?, NAME)?;
            let value = match unit_index(recv.len, arg) {
                Some(i) => f64::from(read_code_unit(&mut *caller, recv.array, i)?),
                None => f64::NAN,
            };
            *abi_result(results, 0)? = Val::F64(value.to_bits());
            Ok(())
        },
    )
}

/// `codePointAt`: the code point starting at the index, joining a surrogate
/// pair, or `undefined` out of range.
fn reg_code_point_at(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
) -> wasmtime::Result<()> {
    const NAME: &str = "codePointAt";
    let s = abi.value_type();
    let object = ValType::Ref(RefType::new(
        true,
        HeapType::ConcreteStruct(build_intrinsic_types(engine)?.object),
    ));
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(NAME),
        FuncType::new(engine, [s, ValType::F64], [object]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, NAME)?;
            let arg = number(abi_arg(params, 1)?, NAME)?;
            let Some(i) = unit_index(recv.len, arg) else {
                *abi_result(results, 0)? = crate::runtime::prelude::undefined::value(caller)?;
                return Ok(());
            };
            let unit = read_code_unit(&mut *caller, recv.array, i)?;
            let next = if i + 1 < recv.len {
                Some(read_code_unit(&mut *caller, recv.array, i + 1)?)
            } else {
                None
            };
            let boxed = write_boxed_number_struct(caller, code_point(unit, next))?;
            *abi_result(results, 0)? = Val::AnyRef(Some(boxed.to_anyref()));
            Ok(())
        },
    )
}

/// `repeat`: the receiver `count` times, built in place (see [`StringAbi::build`]).
fn reg_repeat(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("repeat"),
        FuncType::new(engine, [s.clone(), ValType::F64], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, "repeat")?;
            let count = number(abi_arg(params, 1)?, "repeat")?;
            fuel::charge(&mut *caller, fuel::COPY, recv.len as u64)?;
            let total = repeat_length(recv.len, count).map_err(throw)?;
            fuel::charge(&mut *caller, fuel::COPY, total as u64)?;
            let runs = [recv.cycle(total)];
            *abi_result(results, 0)? = abi.build(caller, recv.vtable, &runs)?;
            Ok(())
        },
    )
}

/// `(string, f64, f64) -> string`: `slice`, `substring`. `range` names the
/// units kept; only those are copied.
fn reg_range_to_str(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    range: fn(usize, f64, f64) -> std::ops::Range<usize>,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone(), ValType::F64, ValType::F64], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            let a = number(abi_arg(params, 1)?, name)?;
            let b = number(abi_arg(params, 2)?, name)?;
            let kept = range(recv.len, a, b);
            let units = read_code_units_range(&mut *caller, recv.array, kept.start, kept.len())?;
            *abi_result(results, 0)? = abi.write(caller, recv.vtable, &Str::from_units(units))?;
            Ok(())
        },
    )
}

/// `(string, string, f64) -> f64`: `indexOf`, `lastIndexOf`.
fn reg_str_str_num_to_num(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    op: fn(&Str, &Str, f64) -> f64,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone(), s, ValType::F64], [ValType::F64]),
        true,
        move |caller, params, results| {
            let recv = abi.read(caller, abi_arg(params, 0)?, name)?;
            let search = abi.read(caller, abi_arg(params, 1)?, name)?;
            let from = number(abi_arg(params, 2)?, name)?;
            fuel::charge(
                &mut *caller,
                fuel::SCAN,
                (recv.value.len() + search.value.len()) as u64,
            )?;
            *abi_result(results, 0)? = Val::F64(op(&recv.value, &search.value, from).to_bits());
            Ok(())
        },
    )
}

/// Search and position stay boxed so RegExp rejection and coercions run in order.
fn register_string_search_predicate(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    op: fn(&Str, &Str, f64) -> bool,
) -> wasmtime::Result<()> {
    let intr = build_intrinsic_types(engine)?;
    let value = ValType::Ref(RefType::new(true, HeapType::ConcreteStruct(intr.object)));
    let abi = abi.clone();
    register_host_fn_async(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(
            engine,
            [abi.value_type(), value.clone(), value],
            [ValType::I32],
        ),
        true,
        move |caller, params, results| {
            let abi = abi.clone();
            Box::pin(async move {
                let recv = abi.read(caller, abi_arg(params, 0)?, name)?;
                let search =
                    super::super::value::search_string(caller, abi_arg(params, 1)?).await?;
                let from = super::super::value::to_number(caller, abi_arg(params, 2)?).await?;
                fuel::charge(
                    &mut *caller,
                    fuel::SCAN,
                    (recv.value.len() + search.len()) as u64,
                )?;
                *abi_result(results, 0)? =
                    Val::I32(op(&recv.value, &Str::from_units(search), from) as i32);
                Ok(())
            })
        },
    )
}

/// `startsWith`, `endsWith`: compare the needle with the one window of the
/// receiver it could occupy, copying nothing else. Search and position stay
/// boxed so RegExp rejection and coercions run in order.
fn reg_window_predicate(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    window: fn(usize, usize, f64) -> Option<std::ops::Range<usize>>,
) -> wasmtime::Result<()> {
    let intr = build_intrinsic_types(engine)?;
    let value = ValType::Ref(RefType::new(true, HeapType::ConcreteStruct(intr.object)));
    let abi = abi.clone();
    register_host_fn_async(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(
            engine,
            [abi.value_type(), value.clone(), value],
            [ValType::I32],
        ),
        true,
        move |caller, params, results| {
            let abi = abi.clone();
            Box::pin(async move {
                let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
                let needle =
                    super::super::value::search_string(caller, abi_arg(params, 1)?).await?;
                let position = super::super::value::to_number(caller, abi_arg(params, 2)?).await?;
                let found = match window(recv.len, needle.len(), position) {
                    Some(range) => {
                        read_code_units_range(caller, recv.array, range.start, range.len())?
                            == needle
                    }
                    None => false,
                };
                *abi_result(results, 0)? = Val::I32(found as i32);
                Ok(())
            })
        },
    )
}

/// `String#concat(...strings)`; the `+` operator registers the two-string
/// operation as `string_concat`.
fn reg_concat(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let array = ValType::Ref(RefType::new(
        false,
        HeapType::ConcreteStruct(crate::runtime::host::intrinsic_array_type(engine)?),
    ));
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key("concat"),
        FuncType::new(engine, [s.clone(), array.clone()], [s]),
        true,
        move |caller, params, results| {
            *abi_result(results, 0)? =
                abi.concat_all(caller, abi_arg(params, 0)?, abi_arg(params, 1)?)?;
            Ok(())
        },
    )
}

/// Which side of the receiver a pad fills.
#[derive(Clone, Copy)]
enum PadSide {
    Start,
    End,
}

/// `padStart`, `padEnd`: repetitions of the pad, cut to fit, beside the receiver.
fn reg_pad(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    side: PadSide,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone(), ValType::F64, s.clone()], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            let target = number(abi_arg(params, 1)?, name)?;
            let pad = abi.payload(caller, abi_arg(params, 2)?, name)?;
            fuel::charge(&mut *caller, fuel::COPY, recv.len as u64 + pad.len as u64)?;
            let total = pad_length(recv.len, target, pad.len).map_err(throw)?;
            fuel::charge(&mut *caller, fuel::COPY, total as u64)?;
            // pad_length never shortens the receiver.
            let fill_len = total
                .checked_sub(recv.len)
                .ok_or_else(|| fatal_host_error("padded string shorter than its receiver"))?;
            let fill = pad.cycle(fill_len);
            let runs = match side {
                PadSide::Start => [fill, recv.whole()],
                PadSide::End => [recv.whole(), fill],
            };
            *abi_result(results, 0)? = abi.build(caller, recv.vtable, &runs)?;
            Ok(())
        },
    )
}

/// `(string, string) -> string` for a builder that can reject its input:
/// `normalize` (invalid form throws).
fn reg_str_str_to_str_fallible(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    op: fn(&Str, &Str) -> super::Result<Str>,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone(), s.clone()], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.read(caller, abi_arg(params, 0)?, name)?;
            let arg = abi.read(caller, abi_arg(params, 1)?, name)?;
            let out = op(&recv.value, &arg.value).map_err(throw)?;
            *abi_result(results, 0)? = abi.write(caller, recv.vtable, &out)?;
            Ok(())
        },
    )
}

/// `(string) -> boolean`: `isWellFormed`.
fn reg_str_to_bool(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    op: fn(&Str) -> bool,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s], [ValType::I32]),
        true,
        move |caller, params, results| {
            let recv = abi.read(caller, abi_arg(params, 0)?, name)?;
            *abi_result(results, 0)? = Val::I32(op(&recv.value) as i32);
            Ok(())
        },
    )
}

/// `(string) -> string`: `toWellFormed`.
fn reg_str_to_str(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    op: fn(&Str) -> Str,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone()], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.read(caller, abi_arg(params, 0)?, name)?;
            // toWellFormed scans the input and its mutable copy.
            fuel::charge(
                &mut *caller,
                fuel::SCAN,
                2 * recv.value.units().len() as u64,
            )?;
            *abi_result(results, 0)? = abi.write(caller, recv.vtable, &op(&recv.value))?;
            Ok(())
        },
    )
}

/// `toUpperCase`, `toLowerCase`: read the receiver and write the result in
/// place (see [`GcText`]).
fn reg_case_map(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    map: fn(&mut GcText<'_, '_>) -> wasmtime::Result<()>,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone()], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            // Read, map, and write a result of the receiver's length; a result
            // of another length pays the difference in `GcText::finish`.
            let len = recv.len as u64;
            fuel::charge(&mut *caller, fuel::COPY, len)?;
            fuel::charge(&mut *caller, fuel::SCAN, len)?;
            fuel::charge(&mut *caller, fuel::COPY, len)?;
            let guess = allocate(caller, &abi.payload_ty, recv.len)?;
            let input = GcUnits::new(caller, recv.array, recv.len);
            let mut text = GcText::new(input, abi.payload_ty.clone(), guess, recv.len);
            map(&mut text)?;
            let payload = text.finish()?;
            *abi_result(results, 0)? = abi.wrap(caller, recv.vtable, payload)?;
            Ok(())
        },
    )
}

/// `trim`, `trimStart`, `trimEnd`: scan the receiver's ends in place and copy
/// the kept range.
fn reg_trim(
    linker: &mut Linker<StoreData>,
    engine: &wasmtime::Engine,
    abi: &StringAbi,
    name: &'static str,
    ends: TrimEnds,
) -> wasmtime::Result<()> {
    let s = abi.value_type();
    let abi = abi.clone();
    register_host_fn(
        linker,
        MODULE_NAME,
        method_key(name),
        FuncType::new(engine, [s.clone()], [s]),
        true,
        move |caller, params, results| {
            let recv = abi.payload(caller, abi_arg(params, 0)?, name)?;
            // The SUB-1292 price; the scan reads only the trimmed ends.
            fuel::charge(&mut *caller, fuel::COPY, recv.len as u64)?;
            fuel::charge(&mut *caller, fuel::SCAN, recv.len as u64)?;
            let kept = trim_range(&mut GcUnits::new(caller, recv.array, recv.len), ends)?;
            fuel::charge(&mut *caller, fuel::COPY, kept.len() as u64)?;
            *abi_result(results, 0)? = abi.build(caller, recv.vtable, &[recv.range_run(kept)])?;
            Ok(())
        },
    )
}

/// The canonical `$string` ABI types, recovered once at install and reused to
/// build every result. `$string` is `(struct (field vtable) (field $rawString))`.
#[derive(Clone)]
struct StringAbi {
    string_ty: StructType,
    payload_ty: ArrayType,
}

/// A `$string` receiver split into its vtable and code units. The result is
/// built with the *same* vtable: it's the one shared `$string` vtable singleton,
/// so reusing the receiver's avoids a prelude-instance lookup.
struct Receiver {
    vtable: Val,
    value: Str,
}

/// A `$string` kept where it is: its payload array and length. Accessors read
/// a few units or a range from it; builders copy from it as the source of a run.
struct Payload {
    vtable: Val,
    array: Rooted<ArrayRef>,
    len: usize,
}

impl Payload {
    /// The units in `range`, copied once.
    fn range_run(&self, range: std::ops::Range<usize>) -> Run {
        Run::copy(self.array, range)
    }

    /// The whole string, copied once.
    fn whole(&self) -> Run {
        Run::copy(self.array, 0..self.len)
    }

    /// `len` units cycling through this string from its start.
    fn cycle(&self, len: usize) -> Run {
        Run {
            source: self.array,
            start: 0,
            period: self.len,
            len,
        }
    }

    fn read_all(&self, caller: &mut Caller<'_, StoreData>, name: &str) -> wasmtime::Result<Str> {
        Ok(Str::from_units(read_code_units(
            &mut *caller,
            self.array,
            name,
        )?))
    }
}

impl StringAbi {
    fn recover(engine: &wasmtime::Engine) -> wasmtime::Result<Self> {
        Ok(Self {
            string_ty: intrinsic_string_type(engine)?,
            payload_ty: string_array_type(engine),
        })
    }

    fn value_type(&self) -> ValType {
        ValType::Ref(RefType::new(
            false,
            HeapType::ConcreteStruct(self.string_ty.clone()),
        ))
    }

    fn read(
        &self,
        caller: &mut Caller<'_, StoreData>,
        val: &Val,
        name: &str,
    ) -> wasmtime::Result<Receiver> {
        let payload = self.payload(caller, val, name)?;
        Ok(Receiver {
            vtable: payload.vtable,
            value: payload.read_all(caller, name)?,
        })
    }

    fn payload(
        &self,
        caller: &mut Caller<'_, StoreData>,
        val: &Val,
        name: &str,
    ) -> wasmtime::Result<Payload> {
        let Val::AnyRef(Some(any)) = val else {
            return Err(wasmtime::Error::msg(format!(
                "{name} expects a string, got {val:?}"
            )));
        };
        let st = any
            .as_struct(&mut *caller)?
            .ok_or_else(|| wasmtime::Error::msg(format!("{name}: expected a $string struct")))?;
        let vtable = st.field(&mut *caller, 0)?;
        let array = match st.field(&mut *caller, 1)? {
            Val::AnyRef(Some(arr)) => arr.unwrap_array(&mut *caller)?,
            other => {
                return Err(wasmtime::Error::msg(format!(
                    "{name}: malformed $string payload {other:?}"
                )));
            }
        };
        let len = usize::try_from(array.len(&mut *caller)?)
            .map_err(crate::runtime::host::fatal_host_error)?;
        Ok(Payload { vtable, array, len })
    }

    fn write(
        &self,
        caller: &mut Caller<'_, StoreData>,
        vtable: Val,
        s: &Str,
    ) -> wasmtime::Result<Val> {
        fuel::charge(&mut *caller, fuel::COPY, s.units().len() as u64)?;
        self.write_units(caller, vtable, s)
    }

    fn write_units(
        &self,
        caller: &mut Caller<'_, StoreData>,
        vtable: Val,
        s: &Str,
    ) -> wasmtime::Result<Val> {
        let pre = ArrayRefPre::new(&mut *caller, self.payload_ty.clone());
        let payload = ArrayRef::new_from_i16_slice(&mut *caller, &pre, s.units())?;
        self.wrap(caller, vtable, payload)
    }

    /// `a` followed by `b`, built in place.
    fn concat(
        &self,
        caller: &mut Caller<'_, StoreData>,
        a: &Val,
        b: &Val,
        name: &str,
    ) -> wasmtime::Result<Val> {
        let a = self.payload(caller, a, name)?;
        let b = self.payload(caller, b, name)?;
        fuel::charge(&mut *caller, fuel::COPY, a.len as u64 + b.len as u64)?;
        let total = concat_length(a.len, b.len)?;
        fuel::charge(&mut *caller, fuel::COPY, total as u64)?;
        self.build(caller, a.vtable, &[a.whole(), b.whole()])
    }

    /// `String#concat`: the receiver followed by each string in `others`, an
    /// `$Array` of the rest arguments.
    fn concat_all(
        &self,
        caller: &mut Caller<'_, StoreData>,
        receiver: &Val,
        others: &Val,
    ) -> wasmtime::Result<Val> {
        let receiver = self.payload(caller, receiver, "concat")?;
        let others =
            crate::runtime::array_storage::ArrayStorage::read(caller, others)?.snapshot(caller)?;
        let mut runs = Vec::with_capacity(others.len() + 1);
        let mut total = receiver.len;
        runs.push(receiver.whole());
        for other in &others {
            let other = self.payload(caller, other, "concat")?;
            total = concat_length(total, other.len)?;
            runs.push(other.whole());
        }
        fuel::charge(&mut *caller, fuel::COPY, total as u64)?;
        self.build(caller, receiver.vtable, &runs)
    }

    /// Builds a string from `runs` directly in a new GC array (see [`gc_text`]).
    fn build(
        &self,
        caller: &mut Caller<'_, StoreData>,
        vtable: Val,
        runs: &[Run],
    ) -> wasmtime::Result<Val> {
        let total = runs
            .iter()
            .try_fold(0usize, |total, run| total.checked_add(run.len))
            .ok_or_else(|| fatal_host_error("string length overflow"))?;
        let payload = allocate(caller, &self.payload_ty, total)?;
        let mut at = 0;
        for run in runs {
            fill_run(&mut *caller, payload, at, run)?;
            at += run.len;
        }
        self.wrap(caller, vtable, payload)
    }

    fn wrap(
        &self,
        caller: &mut Caller<'_, StoreData>,
        vtable: Val,
        payload: Rooted<ArrayRef>,
    ) -> wasmtime::Result<Val> {
        let pre = StructRefPre::new(&mut *caller, self.string_ty.clone());
        let st = StructRef::new(
            &mut *caller,
            &pre,
            &[vtable, Val::AnyRef(Some(payload.to_anyref())), Val::I64(0)],
        )?;
        Ok(Val::AnyRef(Some(st.to_anyref())))
    }
}

/// Read a `$Array` of boxed numbers (the packed rest args of a `fromCharCode` /
/// `fromCodePoint` call) into their `f64` payloads.
/// `String(value)`: null renders `"null"`, as ECMAScript's ToString does; a
/// bigint renders its decimal text; anything else re-enters its vtable
/// `toString` slot.
pub(crate) async fn string_ctor_call(
    caller: &mut Caller<'_, StoreData>,
    value: &Val,
) -> wasmtime::Result<Val> {
    let Val::AnyRef(Some(any)) = value else {
        let st = write_submilli_string_struct(caller, "null")?;
        return Ok(Val::AnyRef(Some(st.to_anyref())));
    };
    let intr = intrinsic_types(&mut *caller)?;
    if let Some(st) = any.as_struct(&mut *caller)?
        && StructType::eq(&st.ty(&*caller)?, &intr.bigint)
    {
        let (sign, limbs) = crate::runtime::prelude::bigint::ops::read_bigint_struct(
            caller,
            value,
            "String(bigint)",
        )?;
        let value = crate::runtime::prelude::bigint::ops::limbs_to_bigint(sign, &limbs)?;
        let text = crate::runtime::prelude::bigint::ops::format_bigint(caller, &value, 10)?;
        let st = write_submilli_string_struct(caller, &text)?;
        return Ok(Val::AnyRef(Some(st.to_anyref())));
    }
    crate::runtime::prelude::vtable::dispatch_vtable_slot(caller, value, 0, &[]).await
}

fn read_number_array(
    caller: &mut Caller<'_, StoreData>,
    val: &Val,
    name: &str,
) -> wasmtime::Result<Vec<f64>> {
    let storage = crate::runtime::array_storage::ArrayStorage::read(caller, val)?;
    let backing = storage.backing;
    let len = storage.len;
    let mut nums = Vec::new();
    nums.try_reserve_exact(len as usize)
        .map_err(crate::runtime::host::fatal_host_error)?;
    for i in 0..len {
        let boxed = match backing.get(&mut *caller, i)? {
            Val::AnyRef(Some(b)) => b
                .as_struct(&mut *caller)?
                .ok_or_else(|| wasmtime::Error::msg(format!("{name}: arg {i} not a struct")))?,
            other => {
                return Err(wasmtime::Error::msg(format!(
                    "{name}: arg {i} is {other:?}, not a boxed number"
                )));
            }
        };
        match boxed.field(&mut *caller, 1)? {
            Val::F64(bits) => nums.push(f64::from_bits(bits)),
            other => {
                return Err(wasmtime::Error::msg(format!(
                    "{name}: arg {i} payload {other:?} is not f64"
                )));
            }
        }
    }
    Ok(nums)
}

fn number(val: &Val, name: &str) -> wasmtime::Result<f64> {
    match val {
        Val::F64(bits) => Ok(f64::from_bits(*bits)),
        other => Err(wasmtime::Error::msg(format!(
            "{name} expects f64, got {other:?}"
        ))),
    }
}

fn throw(e: RangeError) -> wasmtime::Error {
    range_error(e.message())
}

/// The type/interface surface this module implements — its slice of the
/// prelude declaration (see `declaration::prelude_package_declaration`).
#[allow(clippy::too_many_lines)]
pub(crate) fn declare_types(defs: &mut crate::PackageDeclaration) {
    use crate::runtime::prelude::declaration::doc;
    use crate::{
        Dispatch, MethodSig, Param, PropertySig, Span, Type, TypeKind, TypeSymbol, ValueKind,
        ValueSymbol,
    };
    use std::collections::BTreeMap;
    defs.values.insert(
        "string_concat".to_string(),
        ValueSymbol {
            name: "string_concat".to_string(),
            mangled_name: crate::mangle::prelude("string_concat"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Function {
                generics: Vec::new(),
                params: vec![Param::anon(Type::String), Param::anon(Type::String)],
                ret: Type::String,
                type_predicate: None,
                doc: doc("/** Internal: concatenate two strings. */"),
            },
        },
    );
    defs.values.insert(
        "string_eq".to_string(),
        ValueSymbol {
            name: "string_eq".to_string(),
            mangled_name: crate::mangle::prelude("string_eq"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Function {
                generics: Vec::new(),
                params: vec![Param::anon(Type::String), Param::anon(Type::String)],
                ret: Type::Boolean,
                type_predicate: None,
                doc: doc("/** Internal: structural string equality. */"),
            },
        },
    );
    defs.values.insert(
        "string_length".to_string(),
        ValueSymbol {
            name: "string_length".to_string(),
            mangled_name: crate::mangle::prelude("string_length"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Function {
                generics: Vec::new(),
                params: vec![Param::anon(Type::String)],
                ret: Type::Number,
                type_predicate: None,
                doc: doc("/** Internal: UTF-16 code-unit length. */"),
            },
        },
    );
    defs.values.insert(
        "string_index".to_string(),
        ValueSymbol {
            name: "string_index".to_string(),
            mangled_name: crate::mangle::prelude("string_index"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Function {
                generics: Vec::new(),
                params: vec![Param::anon(Type::String), Param::anon(Type::Number)],
                ret: Type::String,
                type_predicate: None,
                doc: doc("/** Internal: `s[index]`, throwing `RangeError` out of range. */"),
            },
        },
    );
    // `ret: Boolean` only to get an i32 result; the value is a comparison sign,
    // never read as a boolean and never user-callable.
    defs.values.insert(
        "string_cmp".to_string(),
        ValueSymbol {
            name: "string_cmp".to_string(),
            mangled_name: crate::mangle::prelude("string_cmp"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Function {
                generics: Vec::new(),
                params: vec![Param::anon(Type::String), Param::anon(Type::String)],
                ret: Type::Boolean,
                type_predicate: None,
                doc: doc("/** Internal: lexicographic compare; i32 sign result. */"),
            },
        },
    );

    for name in [
        "string_true",
        "string_false",
        "string_comma",
        "string_object_object",
        "string_object_function",
        "string_null",
    ] {
        defs.values.insert(
            name.to_string(),
            ValueSymbol {
                name: name.to_string(),
                mangled_name: crate::mangle::prelude(name),
                declaration_span: Span::at(crate::FileId::PRELUDE),
                kind: ValueKind::Const {
                    ty: Type::String,
                    doc: None,
                },
            },
        );
    }
    defs.types.insert(
        "String".to_string(),
        TypeSymbol {
            name: "String".to_string(),
            mangled_name: crate::mangle::prelude("String"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: TypeKind::Interface { index: None,
                generics: Vec::new(),
                methods: BTreeMap::from([
                    (
                        "toString".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc("/** Returns this string unchanged (identity). */"),
                        },
                    ),
                    (
                        "toJson".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/** Returns this string wrapped in `\"…\"` with JSON escapes applied (`\\\"`, `\\\\`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, and `\\u00XX` for control codepoints). */",
                            ),
                        },
                    ),
                    (
                        "concat".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::rest(
                                "strings",
                                Type::Array(Box::new(Type::String)),
                            )],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with each of `strings` appended, in order.\n * The receiver is not modified.\n * @param strings Zero or more strings to append.\n */",
                            ),
                        },
                    ),
                    (
                        "equals".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("other", Type::String)],
                            ret: Type::Boolean,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns `true` when both strings have identical code units.\n * @param other String to compare against.\n */",
                            ),
                        },
                    ),
                    (
                        "localeCompare".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("other", Type::String)],
                            ret: Type::Number,
                            predicate: None,
                            doc: doc(
                                "/**\n * Compares this string with `other` in UTF-16 code-unit order.\n * @param other The string to compare against.\n * @returns A negative number if this sorts before `other`, `0` if equal, a positive number if after. No locale awareness — pure code-unit order.\n */",
                            ),
                        },
                    ),
                    (
                        "iterator".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::prelude_interface("Iterator".to_string(), vec![Type::String]),
                            predicate: None,
                            doc: doc(
                                "/** Returns an `Iterator<string>` of CODE POINTS — surrogate pairs arrive as one two-unit string. Drives `for-of` over a string. */",
                            ),
                        },
                    ),
                    (
                        "isWellFormed".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::Boolean,
                            predicate: None,
                            doc: doc(
                                "/** Returns `true` when the string contains no lone surrogates (it round-trips losslessly through UTF-8). */",
                            ),
                        },
                    ),
                    (
                        "toWellFormed".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/** Returns a copy with every lone surrogate replaced by U+FFFD (`\u{fffd}`); well-formed strings come back unchanged. */",
                            ),
                        },
                    ),
                    (
                        "charAt".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("index", Type::Number)],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the UTF-16 code unit at `index` as a single-character string.\n * Returns `\"\"` if `index` is negative or beyond the string length.\n * @param index Zero-based index of the code unit.\n */",
                            ),
                        },
                    ),
                    (
                        "at".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("index", Type::Number)],
                            ret: Type::Union(vec![Type::String, Type::Undefined]),
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the code unit at `index` as a single-character string. Negative `index` counts from the end.\n * Returns `undefined` on out-of-range. Use `charAt` for the `\"\"`-on-miss form.\n * @param index Zero-based index; negatives count from the end.\n */",
                            ),
                        },
                    ),
                    (
                        "charCodeAt".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("index", Type::Number)],
                            ret: Type::Number,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the UTF-16 code unit at `index` as an integer (0..65535), or `NaN` if out of range.\n * @param index Zero-based index of the code unit.\n */",
                            ),
                        },
                    ),
                    (
                        "codePointAt".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("index", Type::Number)],
                            ret: Type::Union(vec![Type::Number, Type::Undefined]),
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the Unicode code point starting at `index`, decoding surrogate pairs into values up to 0x10FFFF.\n * Returns `undefined` if `index` is out of range.\n * @param index Zero-based index of the first code unit of the code point.\n */",
                            ),
                        },
                    ),
                    (
                        "slice".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::with_default(
                                    "start",
                                    Type::Number,
                                    crate::DefaultValue::Number(0.0),
                                ),
                                // `end` omitted means "to the end".
                                Param::with_default(
                                    "end",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string containing the code units from `start` (inclusive) to `end` (exclusive).\n * Negative values count from the end. The receiver is not modified.\n * @param start First index to copy. Defaults to `0`.\n * @param end Index one past the last to copy. Defaults to the string length.\n */",
                            ),
                        },
                    ),
                    (
                        "substr".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("start", Type::Number),
                                Param::with_default(
                                    "length",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns `length` code units starting at `start`; a negative `start` counts from the end. Deprecated in JavaScript in favour of `slice`.\n * @param start First index to copy.\n * @param length How many code units to copy. Defaults to the rest of the string.\n */",
                            ),
                        },
                    ),
                    (
                        "substring".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::with_default(
                                    "start",
                                    Type::Number,
                                    crate::DefaultValue::Number(0.0),
                                ),
                                Param::with_default(
                                    "end",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Like `slice`, but negative values clamp to `0`, and `start` and `end` are swapped when `start > end`.\n * @param start First index to copy. Defaults to `0`.\n * @param end Index one past the last to copy. Defaults to the string length.\n */",
                            ),
                        },
                    ),
                    (
                        "indexOf".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("search", Type::String),
                                Param::with_default(
                                    "fromIndex",
                                    Type::Number,
                                    crate::DefaultValue::Number(0.0),
                                ),
                            ],
                            ret: Type::Number,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the index of the first occurrence of `search` at or after `fromIndex`, or `-1` if none.\n * An empty `search` returns `min(fromIndex, length)`.\n * @param search Substring to search for.\n * @param fromIndex Index to begin searching from.\n */",
                            ),
                        },
                    ),
                    (
                        "lastIndexOf".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("search", Type::String),
                                Param::with_default(
                                    "fromIndex",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::Number,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns the index of the last occurrence of `search` at or before `fromIndex`, or `-1` if none.\n * @param search Substring to search for.\n * @param fromIndex Highest valid start position to consider. Defaults to the string length.\n */",
                            ),
                        },
                    ),
                    (
                        "includes".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("search", Type::String),
                                Param::with_default(
                                    "fromIndex",
                                    Type::Number,
                                    crate::DefaultValue::Number(0.0),
                                ),
                            ],
                            ret: Type::Boolean,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns `true` if `search` occurs at or after `fromIndex`.\n * @param search Substring to search for.\n * @param fromIndex Index to begin searching from.\n */",
                            ),
                        },
                    ),
                    (
                        "startsWith".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("search", Type::String),
                                Param::with_default(
                                    "position",
                                    Type::Number,
                                    crate::DefaultValue::Number(0.0),
                                ),
                            ],
                            ret: Type::Boolean,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns `true` if the substring starting at `position` begins with `search`.\n * @param search Prefix to test for.\n * @param position Index at which to start the comparison.\n */",
                            ),
                        },
                    ),
                    (
                        "endsWith".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("search", Type::String),
                                Param::with_default(
                                    "endPosition",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::Boolean,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns `true` if the substring ending at `endPosition` ends with `search`.\n * @param search Suffix to test for.\n * @param endPosition Index marking the end (exclusive) of the substring considered.\n */",
                            ),
                        },
                    ),
                    (
                        "repeat".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("count", Type::Number)],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string containing `count` copies of this string concatenated.\n * Zero `count` (or an empty receiver) returns `\"\"`; a negative `count` throws a `RangeError`.\n * @param count Number of repetitions.\n */",
                            ),
                        },
                    ),
                    (
                        "padStart".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("targetLength", Type::Number),
                                Param::with_default(
                                    "padString",
                                    Type::String,
                                    crate::DefaultValue::String(" ".to_string()),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Pads this string with `padString` on the left until the result reaches `targetLength` code units. Returns this string unchanged when no padding is needed or when `padString` is empty.\n * @param targetLength Length of the padded result.\n * @param padString Filler repeated to reach the target.\n */",
                            ),
                        },
                    ),
                    (
                        "padEnd".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new("targetLength", Type::Number),
                                Param::with_default(
                                    "padString",
                                    Type::String,
                                    crate::DefaultValue::String(" ".to_string()),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Pads this string with `padString` on the right until the result reaches `targetLength` code units. Returns this string unchanged when no padding is needed or when `padString` is empty.\n * @param targetLength Length of the padded result.\n * @param padString Filler repeated to reach the target.\n */",
                            ),
                        },
                    ),
                    (
                        "toUpperCase".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with every character converted to its Unicode uppercase form.\n */",
                            ),
                        },
                    ),
                    (
                        "toLowerCase".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with every character converted to its Unicode lowercase form.\n */",
                            ),
                        },
                    ),
                    (
                        "trim".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with Unicode whitespace removed from both ends.\n */",
                            ),
                        },
                    ),
                    (
                        "trimStart".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with Unicode whitespace removed from the start.\n */",
                            ),
                        },
                    ),
                    (
                        "trimLeft".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * The older name of `trimStart`: returns a new string with Unicode whitespace removed from the start.\n */",
                            ),
                        },
                    ),
                    (
                        "trimRight".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * The older name of `trimEnd`: returns a new string with Unicode whitespace removed from the end.\n */",
                            ),
                        },
                    ),
                    (
                        "trimEnd".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: Vec::new(),
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string with Unicode whitespace removed from the end.\n */",
                            ),
                        },
                    ),
                    (
                        "normalize".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::with_default(
                                "form",
                                Type::String,
                                crate::DefaultValue::String("NFC".to_string()),
                            )],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Returns a new string in the specified Unicode normalization form.\n * @param form One of `\"NFC\"`, `\"NFD\"`, `\"NFKC\"`, `\"NFKD\"`; any other value throws `Error`. Defaults to `\"NFC\"`.\n */",
                            ),
                        },
                    ),
                    // regex-arm String overloads. `match`
                    // and `search` re-use the `RegExp.exec` host fn;
                    // `matchAll` / `split` / `replace` / `replaceAll`
                    // are tracked separately.
                    (
                        "match".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new(
                                "re",
                                Type::Union(vec![
                                    Type::String,
                                    Type::prelude_interface("RegExp".to_string(), Vec::new()),
                                ]),
                            )],
                            ret: Type::Union(vec![
                                Type::prelude_interface("RegExpMatch".to_string(), Vec::new()),
                                Type::Null,
                            ]),
                            predicate: None,
                            doc: doc(
                                "/**\n * Find the next match of `re` in this string. Equivalent to `re.exec(this)` (v1; the `g`-flag array shape is a follow-up).\n * @param re The pattern to search for; a string is compiled as a pattern, as `new RegExp(re)` does.\n */",
                            ),
                        },
                    ),
                    (
                        "search".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new(
                                "re",
                                Type::Union(vec![
                                    Type::String,
                                    Type::prelude_interface("RegExp".to_string(), Vec::new()),
                                ]),
                            )],
                            ret: Type::Number,
                            predicate: None,
                            doc: doc(
                                "/**\n * Index of the first match of `re` in this string, or `-1` if no match.\n * @param re The pattern to search for; a string is compiled as a pattern, as `new RegExp(re)` does.\n */",
                            ),
                        },
                    ),
                    (
                        "replace".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new(
                                    "search",
                                    Type::Union(vec![
                                        Type::String,
                                        Type::prelude_interface("RegExp".to_string(), Vec::new()),
                                    ]),
                                ),
                                Param::new(
                                    "replacement",
                                    crate::runtime::prelude::regex::replacement_type(),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Replace the first match of `search` with `replacement`. For a `RegExp` `search`, the replacement may reference numbered captures (`$1`, `$2`) and named captures (`$<name>`); for both `string` and `RegExp` arms, the special tokens `$$` (literal `$`), `$&` (matched substring), `` $` `` (substring before the match), and `$'` (substring after the match) are honoured.\n * @param search Substring or pattern to match.\n * @param replacement The replacement string, or a function called for each match with the matched text, each capture (`undefined` if it didn't participate), the match's offset, the whole string and, when the pattern names groups, an object of them, whose result replaces the match.\n */",
                            ),
                        },
                    ),
                    (
                        "replaceAll".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new(
                                    "search",
                                    Type::Union(vec![
                                        Type::String,
                                        Type::prelude_interface("RegExp".to_string(), Vec::new()),
                                    ]),
                                ),
                                Param::new(
                                    "replacement",
                                    crate::runtime::prelude::regex::replacement_type(),
                                ),
                            ],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Replace every non-overlapping match of `search` with `replacement`. Replacement-token semantics match `replace`.\n * @param search Substring or pattern to match.\n * @param replacement The replacement string.\n */",
                            ),
                        },
                    ),
                    (
                        "split".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![
                                Param::new(
                                    "separator",
                                    Type::Union(vec![
                                        Type::String,
                                        Type::prelude_interface("RegExp".to_string(), Vec::new()),
                                    ]),
                                ),
                                Param::with_default(
                                    "limit",
                                    Type::Number,
                                    crate::DefaultValue::Number(f64::INFINITY),
                                ),
                            ],
                            ret: Type::Array(Box::new(Type::String)),
                            predicate: None,
                            doc: doc(
                                "/**\n * Split this string into pieces by matches of `separator`. For an empty string `separator`, returns each code unit as a separate part. For a `RegExp` `separator`, each match's captured groups are inserted after the part before it, as in JavaScript (`undefined` for a group that didn't participate).\n * @param separator Substring or pattern to split on.\n * @param limit Optional cap on the number of returned parts (default: no limit).\n */",
                            ),
                        },
                    ),
                    (
                        "matchAll".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new(
                                "re",
                                Type::prelude_interface("RegExp".to_string(), Vec::new()),
                            )],
                            ret: Type::Array(Box::new(Type::prelude_interface("RegExpMatch".to_string(), Vec::new()))),
                            predicate: None,
                            doc: doc(
                                "/**\n * Find every non-overlapping match of `re` in this string. Zero-length matches advance by one to avoid infinite loops, per ECMA-262.\n * @param re The pattern to match.\n */",
                            ),
                        },
                    ),
                ]),
                properties: BTreeMap::from([(
                    "length".to_string(),
                    PropertySig {
                        ty: Type::Number,
                        readonly: true,
                        intrinsic: true,
                        optional: false,
                        doc: doc("/** The number of UTF-16 code units in the string. */"),
                    },
                )]),
                dispatch: Dispatch::Direct,
                doc: doc("/** The UTF-16 string type. */"),
            },
        },
    );
    defs.types.insert(
        "StringConstructor".to_string(),
        TypeSymbol {
            name: "StringConstructor".to_string(),
            mangled_name: crate::mangle::prelude("StringConstructor"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: TypeKind::Interface { index: None,
                generics: Vec::new(),
                methods: BTreeMap::from([
                    (
                        "@call".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::new("value", Type::Unknown)],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Convert any value to its string representation: `\"null\"` and `\"undefined\"` for those values, otherwise the value's `toString()` method.\n */",
                            ),
                        },
                    ),
                    (
                        "fromCharCode".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::rest("codes", Type::Array(Box::new(Type::Number)))],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Builds a string from UTF-16 code units — one unit per argument.\n * Each value is truncated and reduced modulo 65536, as JavaScript does, so `-1` is U+FFFF.\n * @param codes Zero or more UTF-16 code units (0–65535).\n */",
                            ),
                        },
                    ),
                    (
                        "fromCodePoint".to_string(),
                        MethodSig {
                            optional: false,
                            generics: Vec::new(),
                            params: vec![Param::rest(
                                "codePoints",
                                Type::Array(Box::new(Type::Number)),
                            )],
                            ret: Type::String,
                            predicate: None,
                            doc: doc(
                                "/**\n * Builds a string from Unicode code points; astral code points (> U+FFFF) encode as surrogate pairs.\n * Throws a `RangeError` on a negative, non-integer, or > U+10FFFF input.\n * @param codePoints Zero or more Unicode code points (0–0x10FFFF).\n */",
                            ),
                        },
                    ),
                ]),
                properties: BTreeMap::new(),
                dispatch: Dispatch::Static,
                doc: doc(
                    "/** Constructor object for `string`. Accessed via the global `String` binding. */",
                ),
            },
        },
    );
    defs.values.insert(
        "String".to_string(),
        ValueSymbol {
            name: "String".to_string(),
            mangled_name: crate::mangle::prelude("String"),
            declaration_span: Span::at(crate::FileId::PRELUDE),
            kind: ValueKind::Const {
                ty: Type::prelude_interface("StringConstructor".to_string(), Vec::new()),
                doc: doc(
                    "/** The `String` constructor — call `String(x)` to convert any value to a string via its `toString()` method. */",
                ),
            },
        },
    );
}