rustfmt_nightly/

expr.rs

use std::borrow::Cow;
use std::cmp::min;

use itertools::Itertools;
use rustc_ast::token::{Delimiter, Lit, LitKind};
use rustc_ast::{ForLoopKind, MatchKind, ast, token};
use rustc_span::{BytePos, Span};
use tracing::debug;

use crate::chains::rewrite_chain;
use crate::closures;
use crate::comment::{
    CharClasses, FindUncommented, combine_strs_with_missing_comments, contains_comment,
    recover_comment_removed, rewrite_comment, rewrite_missing_comment,
};
use crate::config::{Config, ControlBraceStyle, HexLiteralCase, IndentStyle, StyleEdition};
use crate::config::{FloatLiteralTrailingZero, lists::*};
use crate::lists::{
    ListFormatting, Separator, definitive_tactic, itemize_list, shape_for_tactic,
    struct_lit_formatting, struct_lit_shape, struct_lit_tactic, write_list,
};
use crate::macros::{MacroPosition, rewrite_macro};
use crate::matches::rewrite_match;
use crate::overflow::{self, IntoOverflowableItem, OverflowableItem};
use crate::pairs::{PairParts, rewrite_all_pairs, rewrite_pair};
use crate::range::rewrite_range;
use crate::rewrite::{Rewrite, RewriteContext, RewriteError, RewriteErrorExt, RewriteResult};
use crate::shape::{Indent, Shape};
use crate::source_map::{LineRangeUtils, SpanUtils};
use crate::spanned::Spanned;
use crate::stmt;
use crate::string::{StringFormat, rewrite_string};
use crate::types::{PathContext, rewrite_path};
use crate::utils::{
    colon_spaces, contains_skip, count_newlines, filtered_str_fits, first_line_ends_with,
    inner_attributes, last_line_extendable, last_line_width, mk_sp, outer_attributes,
    semicolon_for_expr, unicode_str_width, wrap_str,
};
use crate::vertical::rewrite_with_alignment;
use crate::visitor::FmtVisitor;

impl Rewrite for ast::Expr {
    fn rewrite(&self, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
        self.rewrite_result(context, shape).ok()
    }

    fn rewrite_result(&self, context: &RewriteContext<'_>, shape: Shape) -> RewriteResult {
        format_expr(self, ExprType::SubExpression, context, shape)
    }
}

#[derive(Copy, Clone, PartialEq)]
pub(crate) enum ExprType {
    Statement,
    SubExpression,
}

pub(crate) fn lit_ends_in_dot(lit: &Lit, context: &RewriteContext<'_>) -> bool {
    match lit.kind {
        LitKind::Float => float_lit_ends_in_dot(
            lit.symbol.as_str(),
            lit.suffix.as_ref().map(|s| s.as_str()),
            context.config.float_literal_trailing_zero(),
        ),
        _ => false,
    }
}

pub(crate) fn float_lit_ends_in_dot(
    symbol: &str,
    suffix: Option<&str>,
    float_literal_trailing_zero: FloatLiteralTrailingZero,
) -> bool {
    match float_literal_trailing_zero {
        FloatLiteralTrailingZero::Preserve => symbol.ends_with('.') && suffix.is_none(),
        FloatLiteralTrailingZero::IfNoPostfix | FloatLiteralTrailingZero::Always => false,
        FloatLiteralTrailingZero::Never => {
            let float_parts = parse_float_symbol(symbol).unwrap();
            let has_postfix = float_parts.exponent.is_some() || suffix.is_some();
            let fractional_part_zero = float_parts.is_fractional_part_zero();
            !has_postfix && fractional_part_zero
        }
    }
}

pub(crate) fn format_expr(
    expr: &ast::Expr,
    expr_type: ExprType,
    context: &RewriteContext<'_>,
    shape: Shape,
) -> RewriteResult {
    skip_out_of_file_lines_range_err!(context, expr.span);

    if contains_skip(&*expr.attrs) {
        return Ok(context.snippet(expr.span()).to_owned());
    }
    let shape = if expr_type == ExprType::Statement && semicolon_for_expr(context, expr) {
        shape.sub_width(1, expr.span)?
    } else {
        shape
    };

    let expr_rw = match expr.kind {
        ast::ExprKind::Array(ref expr_vec) => rewrite_array(
            "",
            expr_vec.iter(),
            expr.span,
            context,
            shape,
            choose_separator_tactic(context, expr.span),
            None,
        ),
        ast::ExprKind::Lit(token_lit) => {
            if let Ok(expr_rw) = rewrite_literal(context, token_lit, expr.span, shape) {
                Ok(expr_rw)
            } else {
                if let LitKind::StrRaw(_) = token_lit.kind {
                    Ok(context.snippet(expr.span).trim().into())
                } else {
                    Err(RewriteError::Unknown)
                }
            }
        }
        ast::ExprKind::Call(ref callee, ref args) => {
            let inner_span = mk_sp(callee.span.hi(), expr.span.hi());
            let callee_str = callee.rewrite_result(context, shape)?;
            rewrite_call(context, &callee_str, args, inner_span, shape)
        }
        ast::ExprKind::Move(ref subexpr, move_kw_span) => {
            let inner_span = mk_sp(move_kw_span.hi(), expr.span.hi());
            rewrite_call(
                context,
                "move",
                std::slice::from_ref(subexpr),
                inner_span,
                shape,
            )
        }
        ast::ExprKind::Paren(ref subexpr) => rewrite_paren(context, subexpr, shape, expr.span),
        ast::ExprKind::Binary(op, ref lhs, ref rhs) => {
            // FIXME: format comments between operands and operator
            rewrite_all_pairs(expr, shape, context).or_else(|_| {
                rewrite_pair(
                    &**lhs,
                    &**rhs,
                    PairParts::infix(&format!(" {} ", context.snippet(op.span))),
                    context,
                    shape,
                    context.config.binop_separator(),
                )
            })
        }
        ast::ExprKind::Unary(op, ref subexpr) => rewrite_unary_op(context, op, subexpr, shape),
        ast::ExprKind::Struct(ref struct_expr) => {
            let ast::StructExpr {
                qself,
                fields,
                path,
                rest,
            } = &**struct_expr;
            rewrite_struct_lit(
                context,
                path,
                qself,
                fields,
                rest,
                &expr.attrs,
                expr.span,
                shape,
            )
        }
        ast::ExprKind::Tup(ref items) => {
            rewrite_tuple(context, items.iter(), expr.span, shape, items.len() == 1)
        }
        ast::ExprKind::Let(ref pat, ref expr, _span, _) => rewrite_let(context, shape, pat, expr),
        ast::ExprKind::If(..)
        | ast::ExprKind::ForLoop { .. }
        | ast::ExprKind::Loop(..)
        | ast::ExprKind::While(..) => to_control_flow(expr, expr_type)
            .unknown_error()
            .and_then(|control_flow| control_flow.rewrite_result(context, shape)),
        ast::ExprKind::ConstBlock(ref anon_const) => {
            let rewrite = match anon_const.value.kind {
                ast::ExprKind::Block(ref block, opt_label) => {
                    // Inner attributes are associated with the `ast::ExprKind::ConstBlock` node,
                    // not the `ast::Block` node we're about to rewrite. To prevent dropping inner
                    // attributes call `rewrite_block` directly.
                    // See https://github.com/rust-lang/rustfmt/issues/6158
                    let shape = if context.config.style_edition() >= StyleEdition::Edition2027 {
                        // Shrink the shape by `"const ".len()` before rewriting the block
                        shape.offset_left(6, expr.span)?
                    } else {
                        shape
                    };
                    rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)?
                }
                _ => anon_const.rewrite_result(context, shape)?,
            };
            Ok(format!("const {}", rewrite))
        }
        ast::ExprKind::Block(ref block, opt_label) => {
            match expr_type {
                ExprType::Statement => {
                    if is_unsafe_block(block) {
                        rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
                    } else if let Some(rw) =
                        rewrite_empty_block(context, block, Some(&expr.attrs), opt_label, "", shape)
                    {
                        // Rewrite block without trying to put it in a single line.
                        Ok(rw)
                    } else {
                        let prefix = block_prefix(context, block, shape)?;

                        rewrite_block_with_visitor(
                            context,
                            &prefix,
                            block,
                            Some(&expr.attrs),
                            opt_label,
                            shape,
                            true,
                        )
                    }
                }
                ExprType::SubExpression => {
                    rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
                }
            }
        }
        ast::ExprKind::Match(ref cond, ref arms, kind) => {
            rewrite_match(context, cond, arms, shape, expr.span, &expr.attrs, kind)
        }
        ast::ExprKind::Path(ref qself, ref path) => {
            rewrite_path(context, PathContext::Expr, qself, path, shape)
        }
        ast::ExprKind::Assign(ref lhs, ref rhs, _) => {
            rewrite_assignment(context, lhs, rhs, None, shape)
        }
        ast::ExprKind::AssignOp(ref op, ref lhs, ref rhs) => {
            rewrite_assignment(context, lhs, rhs, Some(op), shape)
        }
        ast::ExprKind::Continue(ref opt_label) => {
            let id_str = match *opt_label {
                Some(label) => {
                    // Ident lose the `r#` prefix in raw labels,　so use the original snippet
                    let label_name = context.snippet(label.ident.span);
                    format!(" {}", label_name)
                }
                None => String::new(),
            };
            Ok(format!("continue{id_str}"))
        }
        ast::ExprKind::Break(ref opt_label, ref opt_expr) => {
            let id_str = match *opt_label {
                Some(label) => {
                    // Ident lose the `r#` prefix in raw labels,　so use the original snippet
                    let label_name = context.snippet(label.ident.span);
                    format!(" {}", label_name)
                }
                None => String::new(),
            };

            if let Some(ref expr) = *opt_expr {
                rewrite_unary_prefix(context, &format!("break{id_str} "), &**expr, shape)
            } else {
                Ok(format!("break{id_str}"))
            }
        }
        ast::ExprKind::Yield(ast::YieldKind::Prefix(ref opt_expr)) => {
            if let Some(ref expr) = *opt_expr {
                rewrite_unary_prefix(context, "yield ", &**expr, shape)
            } else {
                Ok("yield".to_string())
            }
        }
        ast::ExprKind::Closure(ref cl) => closures::rewrite_closure(
            &cl.binder,
            cl.constness,
            cl.capture_clause,
            &cl.coroutine_marker,
            cl.movability,
            &cl.fn_decl,
            &cl.body,
            expr.span,
            context,
            shape,
        ),
        ast::ExprKind::Try(..)
        | ast::ExprKind::Field(..)
        | ast::ExprKind::MethodCall(..)
        | ast::ExprKind::Await(_, _)
        | ast::ExprKind::Use(_, _)
        | ast::ExprKind::Yield(ast::YieldKind::Postfix(_)) => rewrite_chain(expr, context, shape),
        ast::ExprKind::MacCall(ref mac) => {
            rewrite_macro(mac, context, shape, MacroPosition::Expression).or_else(|_| {
                wrap_str(
                    context.snippet(expr.span).to_owned(),
                    context.config.max_width(),
                    context.config.tab_spaces(),
                    shape,
                )
                .max_width_error(shape.width, expr.span)
            })
        }
        ast::ExprKind::Ret(None) => Ok("return".to_owned()),
        ast::ExprKind::Ret(Some(ref expr)) => {
            rewrite_unary_prefix(context, "return ", &**expr, shape)
        }
        ast::ExprKind::Become(ref expr) => rewrite_unary_prefix(context, "become ", &**expr, shape),
        ast::ExprKind::Yeet(None) => Ok("do yeet".to_owned()),
        ast::ExprKind::Yeet(Some(ref expr)) => {
            rewrite_unary_prefix(context, "do yeet ", &**expr, shape)
        }
        ast::ExprKind::AddrOf(borrow_kind, mutability, ref expr) => {
            rewrite_expr_addrof(context, borrow_kind, mutability, expr, shape)
        }
        ast::ExprKind::Cast(ref expr, ref ty) => rewrite_pair(
            &**expr,
            &**ty,
            PairParts::infix(" as "),
            context,
            shape,
            SeparatorPlace::Front,
        ),
        ast::ExprKind::Index(ref expr, ref index, _) => {
            rewrite_index(&**expr, &**index, context, shape)
        }
        ast::ExprKind::Repeat(ref expr, ref repeats) => rewrite_pair(
            &**expr,
            &*repeats.value,
            PairParts::new("[", "; ", "]"),
            context,
            shape,
            SeparatorPlace::Back,
        ),
        ast::ExprKind::Range(ref lhs, ref rhs, limits) => rewrite_range(
            context,
            shape,
            lhs.as_deref(),
            rhs.as_deref(),
            limits.as_str(),
        ),
        // We do not format these expressions yet, but they should still
        // satisfy our width restrictions.
        // Style Guide RFC for InlineAsm variant pending
        // https://github.com/rust-dev-tools/fmt-rfcs/issues/152
        ast::ExprKind::InlineAsm(..) => Ok(context.snippet(expr.span).to_owned()),
        ast::ExprKind::TryBlock(ref block, None) => {
            if let rw @ Ok(_) =
                rewrite_single_line_block(context, "try ", block, Some(&expr.attrs), None, shape)
            {
                rw
            } else {
                // FIXME: 9 sounds like `"do catch ".len()`, so may predate the rename
                // 9 = `try `
                let budget = shape.width.saturating_sub(9);
                Ok(format!(
                    "{}{}",
                    "try ",
                    rewrite_block(
                        block,
                        Some(&expr.attrs),
                        None,
                        context,
                        Shape::legacy(budget, shape.indent)
                    )?
                ))
            }
        }
        ast::ExprKind::TryBlock(ref block, Some(ref ty)) => {
            let keyword = "try bikeshed ";
            // 2 = " {".len()
            let ty_shape = shape
                .shrink_left(keyword.len(), expr.span)
                .and_then(|shape| shape.sub_width(2, expr.span))?;

            let ty_str = ty.rewrite_result(context, ty_shape)?;
            let prefix = format!("{keyword}{ty_str} ");
            if let rw @ Ok(_) =
                rewrite_single_line_block(context, &prefix, block, Some(&expr.attrs), None, shape)
            {
                rw
            } else {
                let budget = shape.width.saturating_sub(prefix.len());
                Ok(format!(
                    "{prefix}{}",
                    rewrite_block(
                        block,
                        Some(&expr.attrs),
                        None,
                        context,
                        Shape::legacy(budget, shape.indent)
                    )?
                ))
            }
        }
        ast::ExprKind::Gen(capture_by, ref block, ref kind, _) => {
            let mover = if matches!(capture_by, ast::CaptureBy::Value { .. }) {
                "move "
            } else {
                ""
            };
            if let rw @ Ok(_) = rewrite_single_line_block(
                context,
                format!("{kind} {mover}").as_str(),
                block,
                Some(&expr.attrs),
                None,
                shape,
            ) {
                rw
            } else {
                // 6 = `async `
                let budget = shape.width.saturating_sub(6);
                Ok(format!(
                    "{kind} {mover}{}",
                    rewrite_block(
                        block,
                        Some(&expr.attrs),
                        None,
                        context,
                        Shape::legacy(budget, shape.indent)
                    )?
                ))
            }
        }
        ast::ExprKind::Underscore => Ok("_".to_owned()),
        ast::ExprKind::FormatArgs(..)
        | ast::ExprKind::Type(..)
        | ast::ExprKind::IncludedBytes(..)
        | ast::ExprKind::OffsetOf(..)
        | ast::ExprKind::UnsafeBinderCast(..)
        | ast::ExprKind::GcaMacro(..) => {
            // These don't normally occur in the AST because macros aren't expanded. However,
            // rustfmt tries to parse macro arguments when formatting macros, so it's not totally
            // impossible for rustfmt to come across one of these nodes when formatting a file.
            // Also, rustfmt might get passed the output from `-Zunpretty=expanded`.
            Err(RewriteError::Unknown)
        }
        ast::ExprKind::Err(_) | ast::ExprKind::Dummy => Err(RewriteError::Unknown),
    };

    expr_rw
        .map(|expr_str| recover_comment_removed(expr_str, expr.span, context))
        .and_then(|expr_str| {
            let attrs = outer_attributes(&expr.attrs);
            let attrs_str = attrs.rewrite_result(context, shape)?;
            let span = mk_sp(
                attrs.last().map_or(expr.span.lo(), |attr| attr.span.hi()),
                expr.span.lo(),
            );
            combine_strs_with_missing_comments(context, &attrs_str, &expr_str, span, shape, false)
        })
}

pub(crate) fn rewrite_array<'a, T: 'a + IntoOverflowableItem<'a>>(
    name: &'a str,
    exprs: impl Iterator<Item = &'a T>,
    span: Span,
    context: &'a RewriteContext<'_>,
    shape: Shape,
    force_separator_tactic: Option<SeparatorTactic>,
    delim_token: Option<Delimiter>,
) -> RewriteResult {
    overflow::rewrite_with_square_brackets(
        context,
        name,
        exprs,
        shape,
        span,
        force_separator_tactic,
        delim_token,
    )
}

fn rewrite_empty_block(
    context: &RewriteContext<'_>,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
    label: Option<ast::Label>,
    prefix: &str,
    shape: Shape,
) -> Option<String> {
    if block_has_statements(block) {
        return None;
    }

    let label_str = rewrite_label(context, label);
    if attrs.map_or(false, |a| !inner_attributes(a).is_empty()) {
        return None;
    }

    if !block_contains_comment(context, block) && shape.width >= 2 {
        return Some(format!("{prefix}{label_str}{{}}"));
    }

    // If a block contains only a single-line comment, then leave it on one line.
    let user_str = context.snippet(block.span);
    let user_str = user_str.trim();
    if user_str.starts_with('{') && user_str.ends_with('}') {
        let comment_str = user_str[1..user_str.len() - 1].trim();
        if block.stmts.is_empty()
            && !comment_str.contains('\n')
            && !comment_str.starts_with("//")
            && comment_str.len() + 4 <= shape.width
        {
            return Some(format!("{prefix}{label_str}{{ {comment_str} }}"));
        }
    }

    None
}

fn block_prefix(context: &RewriteContext<'_>, block: &ast::Block, shape: Shape) -> RewriteResult {
    Ok(match block.rules {
        ast::BlockCheckMode::Unsafe(..) => {
            let snippet = context.snippet(block.span);
            let open_pos = snippet.find_uncommented("{").unknown_error()?;
            // Extract comment between unsafe and block start.
            let trimmed = &snippet[6..open_pos].trim();

            if !trimmed.is_empty() {
                // 9 = "unsafe  {".len(), 7 = "unsafe ".len()
                let budget = shape
                    .width
                    .checked_sub(9)
                    .max_width_error(shape.width, block.span)?;
                format!(
                    "unsafe {} ",
                    rewrite_comment(
                        trimmed,
                        true,
                        Shape::legacy(budget, shape.indent + 7),
                        context.config,
                    )?
                )
            } else {
                "unsafe ".to_owned()
            }
        }
        ast::BlockCheckMode::Default => String::new(),
    })
}

fn rewrite_single_line_block(
    context: &RewriteContext<'_>,
    prefix: &str,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
    label: Option<ast::Label>,
    shape: Shape,
) -> RewriteResult {
    if let Some(block_expr) = stmt::Stmt::from_simple_block(context, block, attrs) {
        let expr_shape = shape.offset_left(
            last_line_width(prefix, context.config.tab_spaces()),
            block_expr.span(),
        )?;
        let expr_str = block_expr.rewrite_result(context, expr_shape)?;
        let label_str = rewrite_label(context, label);
        let result = format!("{prefix}{label_str}{{ {expr_str} }}");
        if result.len() <= shape.width && !result.contains('\n') {
            return Ok(result);
        }
    }
    Err(RewriteError::Unknown)
}

pub(crate) fn rewrite_block_with_visitor(
    context: &RewriteContext<'_>,
    prefix: &str,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
    label: Option<ast::Label>,
    shape: Shape,
    has_braces: bool,
) -> RewriteResult {
    if let Some(rw_str) = rewrite_empty_block(context, block, attrs, label, prefix, shape) {
        return Ok(rw_str);
    }

    let mut visitor = FmtVisitor::from_context(context);
    visitor.block_indent = shape.indent;
    visitor.is_if_else_block = context.is_if_else_block();
    visitor.is_loop_block = context.is_loop_block();
    match (block.rules, label) {
        (ast::BlockCheckMode::Unsafe(..), _) | (ast::BlockCheckMode::Default, Some(_)) => {
            let snippet = context.snippet(block.span);
            let open_pos = snippet.find_uncommented("{").unknown_error()?;
            visitor.last_pos = block.span.lo() + BytePos(open_pos as u32)
        }
        (ast::BlockCheckMode::Default, None) => visitor.last_pos = block.span.lo(),
    }

    let inner_attrs = attrs.map(inner_attributes);
    let label_str = rewrite_label(context, label);
    visitor.visit_block(block, inner_attrs.as_deref(), has_braces);
    let visitor_context = visitor.get_context();
    context
        .skipped_range
        .borrow_mut()
        .append(&mut visitor_context.skipped_range.borrow_mut());
    Ok(format!("{}{}{}", prefix, label_str, visitor.buffer))
}

impl Rewrite for ast::Block {
    fn rewrite(&self, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
        self.rewrite_result(context, shape).ok()
    }

    fn rewrite_result(&self, context: &RewriteContext<'_>, shape: Shape) -> RewriteResult {
        rewrite_block(self, None, None, context, shape)
    }
}

fn rewrite_block(
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
    label: Option<ast::Label>,
    context: &RewriteContext<'_>,
    shape: Shape,
) -> RewriteResult {
    rewrite_block_inner(block, attrs, label, true, context, shape)
}

fn rewrite_block_inner(
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
    label: Option<ast::Label>,
    allow_single_line: bool,
    context: &RewriteContext<'_>,
    shape: Shape,
) -> RewriteResult {
    let prefix = block_prefix(context, block, shape)?;

    // shape.width is used only for the single line case: either the empty block `{}`,
    // or an unsafe expression `unsafe { e }`.
    if let Some(rw_str) = rewrite_empty_block(context, block, attrs, label, &prefix, shape) {
        return Ok(rw_str);
    }

    let result_str =
        rewrite_block_with_visitor(context, &prefix, block, attrs, label, shape, true)?;
    if allow_single_line && result_str.lines().count() <= 3 {
        if let rw @ Ok(_) = rewrite_single_line_block(context, &prefix, block, attrs, label, shape)
        {
            return rw;
        }
    }
    Ok(result_str)
}

/// Rewrite the divergent block of a `let-else` statement.
pub(crate) fn rewrite_let_else_block(
    block: &ast::Block,
    allow_single_line: bool,
    context: &RewriteContext<'_>,
    shape: Shape,
) -> RewriteResult {
    rewrite_block_inner(block, None, None, allow_single_line, context, shape)
}

// Rewrite condition if the given expression has one.
pub(crate) fn rewrite_cond(
    context: &RewriteContext<'_>,
    expr: &ast::Expr,
    shape: Shape,
) -> Option<String> {
    match expr.kind {
        ast::ExprKind::Match(ref cond, _, MatchKind::Prefix) => {
            // `match `cond` {`
            let cond_shape = match context.config.indent_style() {
                IndentStyle::Visual => shape.shrink_left_opt(6).and_then(|s| s.sub_width_opt(2))?,
                IndentStyle::Block => shape.offset_left_opt(8)?,
            };
            cond.rewrite(context, cond_shape)
        }
        _ => to_control_flow(expr, ExprType::SubExpression).and_then(|control_flow| {
            let alt_block_sep =
                String::from("\n") + &shape.indent.block_only().to_string(context.config);
            control_flow
                .rewrite_cond(context, shape, &alt_block_sep)
                .ok()
                .map(|rw| rw.0)
        }),
    }
}

// Abstraction over control flow expressions
#[derive(Debug)]
struct ControlFlow<'a> {
    inner_attributes: Option<Vec<ast::Attribute>>,
    cond: Option<&'a ast::Expr>,
    block: &'a ast::Block,
    else_block: Option<&'a ast::Expr>,
    label: Option<ast::Label>,
    pat: Option<&'a ast::Pat>,
    keyword: &'a str,
    matcher: &'a str,
    connector: &'a str,
    allow_single_line: bool,
    // HACK: `true` if this is an `if` expression in an `else if`.
    nested_if: bool,
    is_loop: bool,
    span: Span,
}

fn extract_pats_and_cond(expr: &ast::Expr) -> (Option<&ast::Pat>, &ast::Expr) {
    match expr.kind {
        ast::ExprKind::Let(ref pat, ref cond, _, _) => (Some(pat), cond),
        _ => (None, expr),
    }
}

// FIXME: Refactor this.
fn to_control_flow(expr: &ast::Expr, expr_type: ExprType) -> Option<ControlFlow<'_>> {
    let inner_attributes = inner_attributes(&expr.attrs);
    match expr.kind {
        ast::ExprKind::If(ref cond, ref if_block, ref else_block) => {
            let (pat, cond) = extract_pats_and_cond(cond);
            Some(ControlFlow::new_if(
                cond,
                pat,
                if_block,
                else_block.as_ref().map(|e| &**e),
                expr_type == ExprType::SubExpression,
                false,
                expr.span,
            ))
        }
        ast::ExprKind::ForLoop(ref f) => Some(ControlFlow::new_for(
            inner_attributes,
            &f.pat,
            &f.iter,
            &f.body,
            f.label,
            expr.span,
            f.kind,
        )),
        ast::ExprKind::Loop(ref block, label, _) => Some(ControlFlow::new_loop(
            inner_attributes,
            block,
            label,
            expr.span,
        )),
        ast::ExprKind::While(ref cond, ref block, label) => {
            let (pat, cond) = extract_pats_and_cond(cond);
            Some(ControlFlow::new_while(
                inner_attributes,
                pat,
                cond,
                block,
                label,
                expr.span,
            ))
        }
        _ => None,
    }
}

fn choose_matcher(pat: Option<&ast::Pat>) -> &'static str {
    pat.map_or("", |_| "let")
}

impl<'a> ControlFlow<'a> {
    fn new_if(
        cond: &'a ast::Expr,
        pat: Option<&'a ast::Pat>,
        block: &'a ast::Block,
        else_block: Option<&'a ast::Expr>,
        allow_single_line: bool,
        nested_if: bool,
        span: Span,
    ) -> ControlFlow<'a> {
        let matcher = choose_matcher(pat);
        ControlFlow {
            inner_attributes: None,
            cond: Some(cond),
            block,
            else_block,
            label: None,
            pat,
            keyword: "if",
            matcher,
            connector: " =",
            allow_single_line,
            nested_if,
            is_loop: false,
            span,
        }
    }

    fn new_loop(
        inner_attributes: Vec<ast::Attribute>,
        block: &'a ast::Block,
        label: Option<ast::Label>,
        span: Span,
    ) -> ControlFlow<'a> {
        ControlFlow {
            inner_attributes: Some(inner_attributes),
            cond: None,
            block,
            else_block: None,
            label,
            pat: None,
            keyword: "loop",
            matcher: "",
            connector: "",
            allow_single_line: false,
            nested_if: false,
            is_loop: true,
            span,
        }
    }

    fn new_while(
        inner_attributes: Vec<ast::Attribute>,
        pat: Option<&'a ast::Pat>,
        cond: &'a ast::Expr,
        block: &'a ast::Block,
        label: Option<ast::Label>,
        span: Span,
    ) -> ControlFlow<'a> {
        let matcher = choose_matcher(pat);
        ControlFlow {
            inner_attributes: Some(inner_attributes),
            cond: Some(cond),
            block,
            else_block: None,
            label,
            pat,
            keyword: "while",
            matcher,
            connector: " =",
            allow_single_line: false,
            nested_if: false,
            is_loop: true,
            span,
        }
    }

    fn new_for(
        inner_attributes: Vec<ast::Attribute>,
        pat: &'a ast::Pat,
        cond: &'a ast::Expr,
        block: &'a ast::Block,
        label: Option<ast::Label>,
        span: Span,
        kind: ForLoopKind,
    ) -> ControlFlow<'a> {
        ControlFlow {
            inner_attributes: Some(inner_attributes),
            cond: Some(cond),
            block,
            else_block: None,
            label,
            pat: Some(pat),
            keyword: match kind {
                ForLoopKind::For => "for",
                ForLoopKind::ForAwait => "for await",
            },
            matcher: "",
            connector: " in",
            allow_single_line: false,
            nested_if: false,
            is_loop: true,
            span,
        }
    }

    fn rewrite_single_line(
        &self,
        pat_expr_str: &str,
        context: &RewriteContext<'_>,
        width: usize,
    ) -> Option<String> {
        assert!(self.allow_single_line);
        let else_block = self.else_block?;
        let fixed_cost = self.keyword.len() + "  {  } else {  }".len();

        if let ast::ExprKind::Block(ref else_node, _) = else_block.kind {
            let (if_expr, else_expr) = match (
                stmt::Stmt::from_simple_block(context, self.block, None),
                stmt::Stmt::from_simple_block(context, else_node, None),
                pat_expr_str.contains('\n'),
            ) {
                (Some(if_expr), Some(else_expr), false) => (if_expr, else_expr),
                _ => return None,
            };

            let new_width = width.checked_sub(pat_expr_str.len() + fixed_cost)?;
            let if_str = if_expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;

            let new_width = new_width.checked_sub(if_str.len())?;
            let else_str = else_expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;

            if if_str.contains('\n') || else_str.contains('\n') {
                return None;
            }

            let result = format!(
                "{} {} {{ {} }} else {{ {} }}",
                self.keyword, pat_expr_str, if_str, else_str
            );

            if result.len() <= width {
                return Some(result);
            }
        }

        None
    }
}

/// Returns `true` if the last line of pat_str has leading whitespace and it is wider than the
/// shape's indent.
fn last_line_offsetted(start_column: usize, pat_str: &str) -> bool {
    let mut leading_whitespaces = 0;
    for c in pat_str.chars().rev() {
        match c {
            '\n' => break,
            _ if c.is_whitespace() => leading_whitespaces += 1,
            _ => leading_whitespaces = 0,
        }
    }
    leading_whitespaces > start_column
}

impl<'a> ControlFlow<'a> {
    fn rewrite_pat_expr(
        &self,
        context: &RewriteContext<'_>,
        expr: &ast::Expr,
        shape: Shape,
        offset: usize,
    ) -> RewriteResult {
        debug!("rewrite_pat_expr {:?} {:?} {:?}", shape, self.pat, expr);

        let cond_shape = shape.offset_left(offset, expr.span)?;
        if let Some(pat) = self.pat {
            let matcher = if self.matcher.is_empty() {
                self.matcher.to_owned()
            } else {
                format!("{} ", self.matcher)
            };
            let pat_shape = cond_shape
                .offset_left(matcher.len(), pat.span)?
                .sub_width(self.connector.len(), pat.span)?;
            let pat_string = pat.rewrite_result(context, pat_shape)?;
            let comments_lo = context
                .snippet_provider
                .span_after(self.span.with_lo(pat.span.hi()), self.connector.trim());
            let comments_span = mk_sp(comments_lo, expr.span.lo());
            return rewrite_assign_rhs_with_comments(
                context,
                &format!("{}{}{}", matcher, pat_string, self.connector),
                expr,
                cond_shape,
                &RhsAssignKind::Expr(&expr.kind, expr.span),
                RhsTactics::Default,
                comments_span,
                true,
            );
        }

        let expr_rw = expr.rewrite_result(context, cond_shape);
        // The expression may (partially) fit on the current line.
        // We do not allow splitting between `if` and condition.
        if self.keyword == "if" || expr_rw.is_ok() {
            return expr_rw;
        }

        // The expression won't fit on the current line, jump to next.
        let nested_shape = shape
            .block_indent(context.config.tab_spaces())
            .with_max_width(context.config);
        let nested_indent_str = nested_shape.indent.to_string_with_newline(context.config);
        expr.rewrite_result(context, nested_shape)
            .map(|expr_rw| format!("{}{}", nested_indent_str, expr_rw))
    }

    fn rewrite_cond(
        &self,
        context: &RewriteContext<'_>,
        shape: Shape,
        alt_block_sep: &str,
    ) -> Result<(String, usize), RewriteError> {
        // Do not take the rhs overhead from the upper expressions into account
        // when rewriting pattern.
        let new_width = context.budget(shape.used_width());
        let fresh_shape = Shape {
            width: new_width,
            ..shape
        };
        let constr_shape = if self.nested_if {
            // We are part of an if-elseif-else chain. Our constraints are tightened.
            // 7 = "} else " .len()
            fresh_shape.offset_left(7, self.span)?
        } else {
            fresh_shape
        };

        let label_string = rewrite_label(context, self.label);

        // Do not include the label in the span.
        let lo = self
            .label
            .map_or(self.span.lo(), |label| label.ident.span.hi());

        // `for await` is spelled with two tokens, and the source is free to
        // separate them with any whitespace or comments. Locate each token in
        // turn rather than searching for the rendered keyword, and keep
        // whatever sits in the gap.
        let (keyword, after_kwd) = if self.keyword == "for await" {
            let after_for = context
                .snippet_provider
                .span_after(mk_sp(lo, self.span.hi()), "for");
            let before_await = context
                .snippet_provider
                .opt_span_before(mk_sp(after_for, self.span.hi()), "await")
                .unknown_error()?;
            let after_await = context
                .snippet_provider
                .opt_span_after(mk_sp(after_for, self.span.hi()), "await")
                .unknown_error()?;

            // "for" + whatever is in the gap + "await"
            let kwd = combine_strs_with_missing_comments(
                context,
                "for",
                "await",
                mk_sp(after_for, before_await),
                shape,
                true,
            )?;
            (kwd, after_await)
        } else {
            (
                self.keyword.to_owned(),
                context
                    .snippet_provider
                    .span_after(mk_sp(lo, self.span.hi()), self.keyword.trim()),
            )
        };

        // 1 = space after keyword.
        let offset =
            last_line_width(&keyword, context.config.tab_spaces()) + label_string.len() + 1;

        let pat_expr_string = match self.cond {
            Some(cond) => self.rewrite_pat_expr(context, cond, constr_shape, offset)?,
            None => String::new(),
        };

        let brace_overhead =
            if context.config.control_brace_style() != ControlBraceStyle::AlwaysNextLine {
                // 2 = ` {`
                2
            } else {
                0
            };
        let one_line_budget = context
            .config
            .max_width()
            .saturating_sub(constr_shape.used_width() + offset + brace_overhead);
        let first_line_indent = if context.config.style_edition() >= StyleEdition::Edition2027 {
            shape.indent.width()
        } else {
            shape.used_width()
        };
        let force_newline_brace = (pat_expr_string.contains('\n')
            || pat_expr_string.len() > one_line_budget)
            && (!last_line_extendable(&pat_expr_string)
                || last_line_offsetted(first_line_indent, &pat_expr_string));

        // Try to format if-else on single line.
        if self.allow_single_line && context.config.single_line_if_else_max_width() > 0 {
            let trial = self.rewrite_single_line(&pat_expr_string, context, shape.width);

            if let Some(cond_str) = trial {
                if cond_str.len() <= context.config.single_line_if_else_max_width() {
                    return Ok((cond_str, 0));
                }
            }
        }

        let cond_span = if let Some(cond) = self.cond {
            cond.span
        } else {
            mk_sp(self.block.span.lo(), self.block.span.lo())
        };

        // `for event in event`
        let between_kwd_cond = mk_sp(
            after_kwd,
            if self.pat.is_none() {
                cond_span.lo()
            } else if self.matcher.is_empty() {
                self.pat.unwrap().span.lo()
            } else {
                context
                    .snippet_provider
                    .span_before(self.span, self.matcher.trim())
            },
        );

        let between_kwd_cond_comment = extract_comment(between_kwd_cond, context, shape);

        let after_cond_comment =
            extract_comment(mk_sp(cond_span.hi(), self.block.span.lo()), context, shape);

        let block_sep = if self.cond.is_none() && between_kwd_cond_comment.is_some() {
            ""
        } else if context.config.control_brace_style() == ControlBraceStyle::AlwaysNextLine
            || force_newline_brace
        {
            alt_block_sep
        } else {
            " "
        };

        let used_width = if pat_expr_string.contains('\n') {
            last_line_width(&pat_expr_string, context.config.tab_spaces())
        } else {
            // 2 = spaces after keyword and condition.
            label_string.len()
                + last_line_width(&keyword, context.config.tab_spaces())
                + pat_expr_string.len()
                + 2
        };

        Ok((
            format!(
                "{}{}{}{}{}",
                label_string,
                keyword,
                between_kwd_cond_comment.as_ref().map_or(
                    if pat_expr_string.is_empty() || pat_expr_string.starts_with('\n') {
                        ""
                    } else {
                        " "
                    },
                    |s| &**s,
                ),
                pat_expr_string,
                after_cond_comment.as_ref().map_or(block_sep, |s| &**s)
            ),
            used_width,
        ))
    }
}

/// Rewrite the `else` keyword with surrounding comments.
///
/// force_newline_else: whether or not to rewrite the `else` keyword on a newline.
/// is_last: true if this is an `else` and `false` if this is an `else if` block.
/// context: rewrite context
/// span: Span between the end of the last expression and the start of the else block,
///       which contains the `else` keyword
/// shape: Shape
pub(crate) fn rewrite_else_kw_with_comments(
    force_newline_else: bool,
    is_last: bool,
    context: &RewriteContext<'_>,
    span: Span,
    shape: Shape,
) -> String {
    let else_kw_lo = context.snippet_provider.span_before(span, "else");
    let before_else_kw = mk_sp(span.lo(), else_kw_lo);
    let before_else_kw_comment = extract_comment(before_else_kw, context, shape);

    let else_kw_hi = context.snippet_provider.span_after(span, "else");
    let after_else_kw = mk_sp(else_kw_hi, span.hi());
    let after_else_kw_comment = extract_comment(after_else_kw, context, shape);

    let newline_sep = &shape.indent.to_string_with_newline(context.config);
    let before_sep = match context.config.control_brace_style() {
        _ if force_newline_else => newline_sep.as_ref(),
        ControlBraceStyle::AlwaysNextLine | ControlBraceStyle::ClosingNextLine => {
            newline_sep.as_ref()
        }
        ControlBraceStyle::AlwaysSameLine => " ",
    };
    let after_sep = match context.config.control_brace_style() {
        ControlBraceStyle::AlwaysNextLine if is_last => newline_sep.as_ref(),
        _ => " ",
    };

    format!(
        "{}else{}",
        before_else_kw_comment.as_ref().map_or(before_sep, |s| &**s),
        after_else_kw_comment.as_ref().map_or(after_sep, |s| &**s),
    )
}

impl<'a> Rewrite for ControlFlow<'a> {
    fn rewrite(&self, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
        self.rewrite_result(context, shape).ok()
    }

    fn rewrite_result(&self, context: &RewriteContext<'_>, shape: Shape) -> RewriteResult {
        debug!("ControlFlow::rewrite {:?} {:?}", self, shape);

        let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
        let (cond_str, used_width) = self.rewrite_cond(context, shape, alt_block_sep)?;
        // If `used_width` is 0, it indicates that whole control flow is written in a single line.
        if used_width == 0 {
            return Ok(cond_str);
        }

        let block_width = shape.width.saturating_sub(used_width);
        // This is used only for the empty block case: `{}`. So, we use 1 if we know
        // we should avoid the single line case.
        let block_width = if self.else_block.is_some() || self.nested_if {
            min(1, block_width)
        } else {
            block_width
        };
        let block_shape = Shape {
            width: block_width,
            ..shape
        };
        let block_str = {
            let old_val = context.is_if_else_block.replace(self.else_block.is_some());
            let old_is_loop = context.is_loop_block.replace(self.is_loop);
            let result = rewrite_block_with_visitor(
                context,
                "",
                self.block,
                self.inner_attributes.as_deref(),
                None,
                block_shape,
                true,
            );
            context.is_loop_block.replace(old_is_loop);
            context.is_if_else_block.replace(old_val);
            result?
        };

        let mut result = format!("{cond_str}{block_str}");

        if let Some(else_block) = self.else_block {
            let shape = Shape::indented(shape.indent, context.config);
            let mut last_in_chain = false;
            let rewrite = match else_block.kind {
                // If the else expression is another if-else expression, prevent it
                // from being formatted on a single line.
                // Note how we're passing the original shape, as the
                // cost of "else" should not cascade.
                ast::ExprKind::If(ref cond, ref if_block, ref next_else_block) => {
                    let (pats, cond) = extract_pats_and_cond(cond);
                    ControlFlow::new_if(
                        cond,
                        pats,
                        if_block,
                        next_else_block.as_ref().map(|e| &**e),
                        false,
                        true,
                        mk_sp(else_block.span.lo(), self.span.hi()),
                    )
                    .rewrite_result(context, shape)
                }
                _ => {
                    last_in_chain = true;
                    // When rewriting a block, the width is only used for single line
                    // blocks, passing 1 lets us avoid that.
                    let else_shape = Shape {
                        width: min(1, shape.width),
                        ..shape
                    };
                    format_expr(else_block, ExprType::Statement, context, else_shape)
                }
            };

            let else_kw = rewrite_else_kw_with_comments(
                false,
                last_in_chain,
                context,
                self.block.span.between(else_block.span),
                shape,
            );
            result.push_str(&else_kw);
            result.push_str(&rewrite?);
        }

        Ok(result)
    }
}

fn rewrite_label(context: &RewriteContext<'_>, opt_label: Option<ast::Label>) -> Cow<'static, str> {
    match opt_label {
        Some(label) => Cow::from(format!("{}: ", context.snippet(label.ident.span))),
        None => Cow::from(""),
    }
}

fn extract_comment(span: Span, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
    match rewrite_missing_comment(span, shape, context) {
        Ok(ref comment) if !comment.is_empty() => Some(format!(
            "{indent}{comment}{indent}",
            indent = shape.indent.to_string_with_newline(context.config)
        )),
        _ => None,
    }
}

pub(crate) fn block_contains_comment(context: &RewriteContext<'_>, block: &ast::Block) -> bool {
    contains_comment(context.snippet(block.span))
}

// Checks that a block contains no statements, an expression and no comments or
// attributes.
// FIXME: incorrectly returns false when comment is contained completely within
// the expression.
pub(crate) fn is_simple_block(
    context: &RewriteContext<'_>,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
) -> bool {
    block.stmts.len() == 1
        && stmt_is_expr(&block.stmts[0])
        && !block_contains_comment(context, block)
        && attrs.map_or(true, |a| a.is_empty())
}

/// Checks whether a block contains at most one statement or expression, and no
/// comments or attributes.
pub(crate) fn is_simple_block_stmt(
    context: &RewriteContext<'_>,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
) -> bool {
    block.stmts.len() <= 1
        && !block_contains_comment(context, block)
        && attrs.map_or(true, |a| a.is_empty())
}

fn block_has_statements(block: &ast::Block) -> bool {
    block
        .stmts
        .iter()
        .any(|stmt| !matches!(stmt.kind, ast::StmtKind::Empty))
}

/// Checks whether a block contains no statements, expressions, comments, or
/// inner attributes.
pub(crate) fn is_empty_block(
    context: &RewriteContext<'_>,
    block: &ast::Block,
    attrs: Option<&[ast::Attribute]>,
) -> bool {
    !block_has_statements(block)
        && !block_contains_comment(context, block)
        && attrs.map_or(true, |a| inner_attributes(a).is_empty())
}

pub(crate) fn stmt_is_expr(stmt: &ast::Stmt) -> bool {
    matches!(stmt.kind, ast::StmtKind::Expr(..))
}

pub(crate) fn is_unsafe_block(block: &ast::Block) -> bool {
    matches!(block.rules, ast::BlockCheckMode::Unsafe(..))
}

pub(crate) fn rewrite_literal(
    context: &RewriteContext<'_>,
    token_lit: token::Lit,
    span: Span,
    shape: Shape,
) -> RewriteResult {
    match token_lit.kind {
        token::LitKind::Str => rewrite_string_lit(context, span, shape),
        token::LitKind::Integer => rewrite_int_lit(context, token_lit, span, shape),
        token::LitKind::Float => rewrite_float_lit(context, token_lit, span, shape),
        _ => wrap_str(
            context.snippet(span).to_owned(),
            context.config.max_width(),
            context.config.tab_spaces(),
            shape,
        )
        .max_width_error(shape.width, span),
    }
}

fn rewrite_string_lit(context: &RewriteContext<'_>, span: Span, shape: Shape) -> RewriteResult {
    let string_lit = context.snippet(span);

    if !context.config.format_strings() {
        if string_lit
            .lines()
            .dropping_back(1)
            .all(|line| line.ends_with('\\'))
            && context.config.style_edition() >= StyleEdition::Edition2024
        {
            return Ok(string_lit.to_owned());
        } else {
            return wrap_str(
                string_lit.to_owned(),
                context.config.max_width(),
                context.config.tab_spaces(),
                shape,
            )
            .max_width_error(shape.width, span);
        }
    }

    // Remove the quote characters.
    let str_lit = &string_lit[1..string_lit.len() - 1];

    rewrite_string(
        str_lit,
        &StringFormat::new(shape.visual_indent(0), context.config),
        shape.width.saturating_sub(2),
    )
    .max_width_error(shape.width, span)
}

fn rewrite_int_lit(
    context: &RewriteContext<'_>,
    token_lit: token::Lit,
    span: Span,
    shape: Shape,
) -> RewriteResult {
    if token_lit.is_semantic_float() {
        return rewrite_float_lit(context, token_lit, span, shape);
    }

    let symbol = token_lit.symbol.as_str();

    if let Some(symbol_stripped) = symbol.strip_prefix("0x") {
        let hex_lit = match context.config.hex_literal_case() {
            HexLiteralCase::Preserve => None,
            HexLiteralCase::Upper => Some(symbol_stripped.to_ascii_uppercase()),
            HexLiteralCase::Lower => Some(symbol_stripped.to_ascii_lowercase()),
        };
        if let Some(hex_lit) = hex_lit {
            return wrap_str(
                format!(
                    "0x{}{}",
                    hex_lit,
                    token_lit.suffix.as_ref().map_or("", |s| s.as_str())
                ),
                context.config.max_width(),
                context.config.tab_spaces(),
                shape,
            )
            .max_width_error(shape.width, span);
        }
    }

    wrap_str(
        context.snippet(span).to_owned(),
        context.config.max_width(),
        context.config.tab_spaces(),
        shape,
    )
    .max_width_error(shape.width, span)
}

fn rewrite_float_lit(
    context: &RewriteContext<'_>,
    token_lit: token::Lit,
    span: Span,
    shape: Shape,
) -> RewriteResult {
    if matches!(
        context.config.float_literal_trailing_zero(),
        FloatLiteralTrailingZero::Preserve
    ) {
        return wrap_str(
            context.snippet(span).to_owned(),
            context.config.max_width(),
            context.config.tab_spaces(),
            shape,
        )
        .max_width_error(shape.width, span);
    }

    let symbol = token_lit.symbol.as_str();
    let suffix = token_lit.suffix.as_ref().map(|s| s.as_str());

    let float_parts = parse_float_symbol(symbol).unwrap();
    let FloatSymbolParts {
        integer_part,
        fractional_part,
        exponent,
    } = float_parts;

    let has_postfix = exponent.is_some() || suffix.is_some();
    let fractional_part_nonzero = !float_parts.is_fractional_part_zero();

    let (include_period, include_fractional_part) =
        match context.config.float_literal_trailing_zero() {
            FloatLiteralTrailingZero::Preserve => unreachable!("handled above"),
            FloatLiteralTrailingZero::Always => (true, true),
            FloatLiteralTrailingZero::IfNoPostfix => (
                fractional_part_nonzero || !has_postfix,
                fractional_part_nonzero || !has_postfix,
            ),
            FloatLiteralTrailingZero::Never => (
                fractional_part_nonzero || !has_postfix,
                fractional_part_nonzero,
            ),
        };

    let period = if include_period { "." } else { "" };
    let fractional_part = if include_fractional_part {
        fractional_part.unwrap_or("0")
    } else {
        ""
    };
    wrap_str(
        format!(
            "{}{}{}{}{}",
            integer_part,
            period,
            fractional_part,
            exponent.unwrap_or(""),
            suffix.unwrap_or(""),
        ),
        context.config.max_width(),
        context.config.tab_spaces(),
        shape,
    )
    .max_width_error(shape.width, span)
}

fn choose_separator_tactic(context: &RewriteContext<'_>, span: Span) -> Option<SeparatorTactic> {
    if context.inside_macro() {
        if span_ends_with_comma(context, span) {
            Some(SeparatorTactic::Always)
        } else {
            Some(SeparatorTactic::Never)
        }
    } else {
        None
    }
}

pub(crate) fn rewrite_call(
    context: &RewriteContext<'_>,
    callee: &str,
    args: &[Box<ast::Expr>],
    span: Span,
    shape: Shape,
) -> RewriteResult {
    overflow::rewrite_with_parens(
        context,
        callee,
        args.iter(),
        shape,
        span,
        context.config.fn_call_width(),
        choose_separator_tactic(context, span),
    )
}

pub(crate) fn is_simple_expr(expr: &ast::Expr) -> bool {
    match expr.kind {
        ast::ExprKind::Lit(..) => true,
        ast::ExprKind::Path(ref qself, ref path) => qself.is_none() && path.segments.len() <= 1,
        ast::ExprKind::AddrOf(_, _, ref expr)
        | ast::ExprKind::Cast(ref expr, _)
        | ast::ExprKind::Field(ref expr, _)
        | ast::ExprKind::Try(ref expr)
        | ast::ExprKind::Unary(_, ref expr) => is_simple_expr(expr),
        ast::ExprKind::Index(ref lhs, ref rhs, _) => is_simple_expr(lhs) && is_simple_expr(rhs),
        ast::ExprKind::Repeat(ref lhs, ref rhs) => {
            is_simple_expr(lhs) && is_simple_expr(&*rhs.value)
        }
        _ => false,
    }
}

pub(crate) fn is_every_expr_simple(lists: &[OverflowableItem<'_>]) -> bool {
    lists.iter().all(OverflowableItem::is_simple)
}

pub(crate) fn can_be_overflowed_expr(
    context: &RewriteContext<'_>,
    expr: &ast::Expr,
    args_len: usize,
) -> bool {
    match expr.kind {
        _ if !expr.attrs.is_empty() => false,
        ast::ExprKind::Match(..) => {
            (context.use_block_indent() && args_len == 1)
                || (context.config.indent_style() == IndentStyle::Visual && args_len > 1)
                || context.config.overflow_delimited_expr()
        }
        ast::ExprKind::If(..)
        | ast::ExprKind::ForLoop { .. }
        | ast::ExprKind::Loop(..)
        | ast::ExprKind::While(..) => {
            context.config.combine_control_expr() && context.use_block_indent() && args_len == 1
        }

        // Handle always block-like expressions
        ast::ExprKind::Gen(..)
        | ast::ExprKind::Block(..)
        | ast::ExprKind::Closure(..)
        | ast::ExprKind::TryBlock(..) => true,

        // Handle `[]` and `{}`-like expressions
        ast::ExprKind::Array(..) | ast::ExprKind::Struct(..) => {
            context.config.overflow_delimited_expr()
                || (context.use_block_indent() && args_len == 1)
        }
        ast::ExprKind::MacCall(ref mac) => {
            match (mac.args.delim, context.config.overflow_delimited_expr()) {
                (Delimiter::Bracket, true) | (Delimiter::Brace, true) => true,
                _ => context.use_block_indent() && args_len == 1,
            }
        }

        // Handle parenthetical expressions
        ast::ExprKind::Call(..) | ast::ExprKind::MethodCall(..) | ast::ExprKind::Tup(..) => {
            context.use_block_indent() && args_len == 1
        }

        // Handle unary-like expressions
        ast::ExprKind::AddrOf(_, _, ref expr)
        | ast::ExprKind::Try(ref expr)
        | ast::ExprKind::Unary(_, ref expr)
        | ast::ExprKind::Cast(ref expr, _) => can_be_overflowed_expr(context, expr, args_len),
        _ => false,
    }
}

pub(crate) fn is_nested_call(expr: &ast::Expr) -> bool {
    match expr.kind {
        ast::ExprKind::Call(..) | ast::ExprKind::MacCall(..) => true,
        ast::ExprKind::AddrOf(_, _, ref expr)
        | ast::ExprKind::Try(ref expr)
        | ast::ExprKind::Unary(_, ref expr)
        | ast::ExprKind::Cast(ref expr, _) => is_nested_call(expr),
        _ => false,
    }
}

/// Returns `true` if a function call or a method call represented by the given span ends with a
/// trailing comma. This function is used when rewriting macro, as adding or removing a trailing
/// comma from macro can potentially break the code.
pub(crate) fn span_ends_with_comma(context: &RewriteContext<'_>, span: Span) -> bool {
    let mut result: bool = Default::default();
    let mut prev_char: char = Default::default();
    let closing_delimiters = &[')', '}', ']'];

    for (kind, c) in CharClasses::new(context.snippet(span).chars()) {
        match c {
            _ if kind.is_comment() || c.is_whitespace() => continue,
            c if closing_delimiters.contains(&c) => {
                result &= !closing_delimiters.contains(&prev_char);
            }
            ',' => result = true,
            _ => result = false,
        }
        prev_char = c;
    }

    result
}

pub(crate) fn rewrite_paren(
    context: &RewriteContext<'_>,
    mut subexpr: &ast::Expr,
    shape: Shape,
    mut span: Span,
) -> RewriteResult {
    debug!("rewrite_paren, shape: {:?}", shape);

    // Extract comments within parens.
    let mut pre_span;
    let mut post_span;
    let mut pre_comment;
    let mut post_comment;
    let remove_nested_parens = context.config.remove_nested_parens();
    loop {
        // 1 = "(" or ")"
        pre_span = mk_sp(span.lo() + BytePos(1), subexpr.span().lo());
        post_span = mk_sp(subexpr.span.hi(), span.hi() - BytePos(1));
        pre_comment = rewrite_missing_comment(pre_span, shape, context)?;
        post_comment = rewrite_missing_comment(post_span, shape, context)?;

        // Remove nested parens if there are no comments.
        if let ast::ExprKind::Paren(ref subsubexpr) = subexpr.kind {
            if remove_nested_parens && pre_comment.is_empty() && post_comment.is_empty() {
                span = subexpr.span;
                subexpr = subsubexpr;
                continue;
            }
        }

        break;
    }

    // 1 = `(` and `)`
    let sub_shape = shape.offset_left(1, span)?.sub_width(1, span)?;
    let subexpr_str = subexpr.rewrite_result(context, sub_shape)?;
    let fits_single_line = !pre_comment.contains("//") && !post_comment.contains("//");
    if fits_single_line {
        Ok(format!("({pre_comment}{subexpr_str}{post_comment})"))
    } else {
        rewrite_paren_in_multi_line(context, subexpr, shape, pre_span, post_span)
    }
}

fn rewrite_paren_in_multi_line(
    context: &RewriteContext<'_>,
    subexpr: &ast::Expr,
    shape: Shape,
    pre_span: Span,
    post_span: Span,
) -> RewriteResult {
    let nested_indent = shape.indent.block_indent(context.config);
    let nested_shape = Shape::indented(nested_indent, context.config);
    let pre_comment = rewrite_missing_comment(pre_span, nested_shape, context)?;
    let post_comment = rewrite_missing_comment(post_span, nested_shape, context)?;
    let subexpr_str = subexpr.rewrite_result(context, nested_shape)?;

    let mut result = String::with_capacity(subexpr_str.len() * 2);
    result.push('(');
    if !pre_comment.is_empty() {
        result.push_str(&nested_indent.to_string_with_newline(context.config));
        result.push_str(&pre_comment);
    }
    result.push_str(&nested_indent.to_string_with_newline(context.config));
    result.push_str(&subexpr_str);
    if !post_comment.is_empty() {
        result.push_str(&nested_indent.to_string_with_newline(context.config));
        result.push_str(&post_comment);
    }
    result.push_str(&shape.indent.to_string_with_newline(context.config));
    result.push(')');

    Ok(result)
}

fn rewrite_index(
    expr: &ast::Expr,
    index: &ast::Expr,
    context: &RewriteContext<'_>,
    shape: Shape,
) -> RewriteResult {
    let expr_str = expr.rewrite_result(context, shape)?;

    let offset = last_line_width(&expr_str, context.config.tab_spaces()) + 1;
    let rhs_overhead = shape.rhs_overhead(context.config);
    let index_shape = if expr_str.contains('\n') {
        Shape::legacy(context.config.max_width(), shape.indent)
            .offset_left(offset, index.span())
            .and_then(|shape| shape.sub_width(1 + rhs_overhead, index.span()))
    } else {
        match context.config.indent_style() {
            IndentStyle::Block => shape
                .offset_left(offset, index.span())
                .and_then(|shape| shape.sub_width(1, index.span())),
            IndentStyle::Visual => shape
                .visual_indent(offset)
                .sub_width(offset + 1, index.span()),
        }
    };
    let orig_index_rw = index_shape
        .map_err(RewriteError::from)
        .and_then(|s| index.rewrite_result(context, s));

    // Return if index fits in a single line.
    match orig_index_rw {
        Ok(ref index_str) if !index_str.contains('\n') => {
            return Ok(format!("{expr_str}[{index_str}]"));
        }
        _ => (),
    }

    // Try putting index on the next line and see if it fits in a single line.
    let indent = shape.indent.block_indent(context.config);
    let index_shape = Shape::indented(indent, context.config)
        .offset_left(1, index.span())?
        .sub_width(1 + rhs_overhead, index.span())?;
    let new_index_rw = index.rewrite_result(context, index_shape);
    match (orig_index_rw, new_index_rw) {
        (_, Ok(ref new_index_str)) if !new_index_str.contains('\n') => Ok(format!(
            "{}{}[{}]",
            expr_str,
            indent.to_string_with_newline(context.config),
            new_index_str,
        )),
        (Err(_), Ok(ref new_index_str)) => Ok(format!(
            "{}{}[{}]",
            expr_str,
            indent.to_string_with_newline(context.config),
            new_index_str,
        )),
        (Ok(ref index_str), _) => Ok(format!("{expr_str}[{index_str}]")),
        // When both orig_index_rw and new_index_rw result in errors, we currently propagate the
        // error from the second attempt since it is more generous with width constraints.
        // This decision is somewhat arbitrary and is open to change.
        (Err(_), Err(new_index_rw_err)) => Err(new_index_rw_err),
    }
}

fn struct_lit_can_be_aligned(fields: &[ast::ExprField], has_base: bool) -> bool {
    !has_base && fields.iter().all(|field| !field.is_shorthand)
}

fn rewrite_struct_lit<'a>(
    context: &RewriteContext<'_>,
    path: &ast::Path,
    qself: &Option<Box<ast::QSelf>>,
    fields: &'a [ast::ExprField],
    struct_rest: &ast::StructRest,
    attrs: &[ast::Attribute],
    span: Span,
    shape: Shape,
) -> RewriteResult {
    debug!("rewrite_struct_lit: shape {:?}", shape);

    enum StructLitField<'a> {
        Regular(&'a ast::ExprField),
        Base(&'a ast::Expr),
        Rest(Span),
    }

    // 2 = " {".len()
    let path_shape = shape.sub_width(2, span)?;
    let path_str = rewrite_path(context, PathContext::Expr, qself, path, path_shape)?;

    let has_base_or_rest = match struct_rest {
        ast::StructRest::None if fields.is_empty() => return Ok(format!("{path_str} {{}}")),
        ast::StructRest::Rest(_) if fields.is_empty() => {
            return Ok(format!("{path_str} {{ .. }}"));
        }
        ast::StructRest::Rest(_) | ast::StructRest::Base(_) => true,
        _ => false,
    };

    // Foo { a: Foo } - indent is +3, width is -5.
    let (h_shape, v_shape) = struct_lit_shape(shape, context, path_str.len() + 3, 2, span)?;

    let one_line_width = h_shape.map_or(0, |shape| shape.width);
    let body_lo = context.snippet_provider.span_after(span, "{");
    let fields_str = if struct_lit_can_be_aligned(fields, has_base_or_rest)
        && context.config.struct_field_align_threshold() > 0
    {
        rewrite_with_alignment(
            fields,
            context,
            v_shape,
            mk_sp(body_lo, span.hi()),
            one_line_width,
        )
        .unknown_error()?
    } else {
        let field_iter = fields.iter().map(StructLitField::Regular).chain(
            match struct_rest {
                ast::StructRest::Base(expr) => Some(StructLitField::Base(&**expr)),
                ast::StructRest::Rest(span) => Some(StructLitField::Rest(*span)),
                ast::StructRest::None | ast::StructRest::NoneWithError(_) => None,
            }
            .into_iter(),
        );

        let span_lo = |item: &StructLitField<'_>| match *item {
            StructLitField::Regular(field) => field.span().lo(),
            StructLitField::Base(expr) => {
                let last_field_hi = fields.last().map_or(span.lo(), |field| field.span.hi());
                let snippet = context.snippet(mk_sp(last_field_hi, expr.span.lo()));
                let pos = snippet.find_uncommented("..").unwrap();
                last_field_hi + BytePos(pos as u32)
            }
            StructLitField::Rest(span) => span.lo(),
        };
        let span_hi = |item: &StructLitField<'_>| match *item {
            StructLitField::Regular(field) => field.span().hi(),
            StructLitField::Base(expr) => expr.span.hi(),
            StructLitField::Rest(span) => span.hi(),
        };
        let rewrite = |item: &StructLitField<'_>| match *item {
            StructLitField::Regular(field) => {
                // The 1 taken from the v_budget is for the comma.
                rewrite_field(context, field, v_shape.sub_width(1, span)?, 0)
            }
            StructLitField::Base(expr) => {
                // 2 = ..
                expr.rewrite_result(context, v_shape.offset_left(2, span)?)
                    .map(|s| format!("..{}", s))
            }
            StructLitField::Rest(_) => Ok("..".to_owned()),
        };

        let items = itemize_list(
            context.snippet_provider,
            field_iter,
            "}",
            ",",
            span_lo,
            span_hi,
            rewrite,
            body_lo,
            span.hi(),
            false,
        );
        let item_vec = items.collect::<Vec<_>>();

        let tactic = struct_lit_tactic(h_shape, context, &item_vec);
        let nested_shape = shape_for_tactic(tactic, h_shape, v_shape);

        let ends_with_comma = span_ends_with_comma(context, span);
        let force_no_trailing_comma = context.inside_macro() && !ends_with_comma;

        let fmt = struct_lit_formatting(
            nested_shape,
            tactic,
            context,
            force_no_trailing_comma || has_base_or_rest || !context.use_block_indent(),
        );

        write_list(&item_vec, &fmt)?
    };

    let fields_str =
        wrap_struct_field(context, attrs, &fields_str, shape, v_shape, one_line_width)?;
    Ok(format!("{path_str} {{{fields_str}}}"))

    // FIXME if context.config.indent_style() == Visual, but we run out
    // of space, we should fall back to BlockIndent.
}

pub(crate) fn wrap_struct_field(
    context: &RewriteContext<'_>,
    attrs: &[ast::Attribute],
    fields_str: &str,
    shape: Shape,
    nested_shape: Shape,
    one_line_width: usize,
) -> RewriteResult {
    let should_vertical = context.config.indent_style() == IndentStyle::Block
        && (fields_str.contains('\n')
            || !context.config.struct_lit_single_line()
            || fields_str.len() > one_line_width);

    let inner_attrs = &inner_attributes(attrs);
    if inner_attrs.is_empty() {
        if should_vertical {
            Ok(format!(
                "{}{}{}",
                nested_shape.indent.to_string_with_newline(context.config),
                fields_str,
                shape.indent.to_string_with_newline(context.config)
            ))
        } else {
            // One liner or visual indent.
            Ok(format!(" {fields_str} "))
        }
    } else {
        Ok(format!(
            "{}{}{}{}{}",
            nested_shape.indent.to_string_with_newline(context.config),
            inner_attrs.rewrite_result(context, shape)?,
            nested_shape.indent.to_string_with_newline(context.config),
            fields_str,
            shape.indent.to_string_with_newline(context.config)
        ))
    }
}

pub(crate) fn struct_lit_field_separator(config: &Config) -> &str {
    colon_spaces(config)
}

pub(crate) fn rewrite_field(
    context: &RewriteContext<'_>,
    field: &ast::ExprField,
    shape: Shape,
    prefix_max_width: usize,
) -> RewriteResult {
    if contains_skip(&field.attrs) {
        return Ok(context.snippet(field.span()).to_owned());
    }
    let mut attrs_str = field.attrs.rewrite_result(context, shape)?;
    if !attrs_str.is_empty() {
        attrs_str.push_str(&shape.indent.to_string_with_newline(context.config));
    };
    let name = context.snippet(field.ident.span);
    if field.is_shorthand {
        Ok(attrs_str + name)
    } else {
        let mut separator = String::from(struct_lit_field_separator(context.config));
        for _ in 0..prefix_max_width.saturating_sub(name.len()) {
            separator.push(' ');
        }
        let overhead = name.len() + separator.len();
        let expr_shape = shape.offset_left(overhead, field.span)?;
        let expr = field.expr.rewrite_result(context, expr_shape);
        let is_lit = matches!(field.expr.kind, ast::ExprKind::Lit(_));
        match expr {
            // A macro can give `Field: value` its own meaning, so shortening `a: a` to `a` may
            // change what it expands to. In `winnow::seq!` the result no longer compiles.
            Ok(ref e)
                if !is_lit
                    && e.as_str() == name
                    && context.config.use_field_init_shorthand()
                    && !context.inside_macro() =>
            {
                Ok(attrs_str + name)
            }
            Ok(e) => Ok(format!("{attrs_str}{name}{separator}{e}")),
            Err(_) => {
                let expr_offset = shape.indent.block_indent(context.config);
                let expr = field
                    .expr
                    .rewrite_result(context, Shape::indented(expr_offset, context.config));
                expr.map(|s| {
                    format!(
                        "{}{}:\n{}{}",
                        attrs_str,
                        name,
                        expr_offset.to_string(context.config),
                        s
                    )
                })
            }
        }
    }
}

fn rewrite_tuple_in_visual_indent_style<'a, T: 'a + IntoOverflowableItem<'a>>(
    context: &RewriteContext<'_>,
    mut items: impl Iterator<Item = &'a T>,
    span: Span,
    shape: Shape,
    is_singleton_tuple: bool,
) -> RewriteResult {
    // In case of length 1, need a trailing comma
    debug!("rewrite_tuple_in_visual_indent_style {:?}", shape);
    if is_singleton_tuple {
        // 3 = "(" + ",)"
        let nested_shape = shape.sub_width(3, span)?.visual_indent(1);
        return items
            .next()
            .unwrap()
            .rewrite_result(context, nested_shape)
            .map(|s| format!("({},)", s));
    }

    let list_lo = context.snippet_provider.span_after(span, "(");
    let nested_shape = shape.sub_width(2, span)?.visual_indent(1);
    let items = itemize_list(
        context.snippet_provider,
        items,
        ")",
        ",",
        |item| item.span().lo(),
        |item| item.span().hi(),
        |item| item.rewrite_result(context, nested_shape),
        list_lo,
        span.hi() - BytePos(1),
        false,
    );
    let item_vec: Vec<_> = items.collect();
    let tactic = definitive_tactic(
        &item_vec,
        ListTactic::HorizontalVertical,
        Separator::Comma,
        nested_shape.width,
    );
    let fmt = ListFormatting::new(nested_shape, context.config)
        .tactic(tactic)
        .ends_with_newline(false);
    let list_str = write_list(&item_vec, &fmt)?;

    Ok(format!("({list_str})"))
}

fn rewrite_let(
    context: &RewriteContext<'_>,
    shape: Shape,
    pat: &ast::Pat,
    expr: &ast::Expr,
) -> RewriteResult {
    let mut result = "let ".to_owned();

    // TODO(ytmimi) comments could appear between `let` and the `pat`

    // 4 = "let ".len()
    let mut pat_shape = shape.offset_left(4, pat.span)?;
    if context.config.style_edition() >= StyleEdition::Edition2027 {
        // 2 for the length of " ="
        pat_shape = pat_shape.sub_width(2, pat.span)?;
    }
    let pat_str = pat.rewrite_result(context, pat_shape)?;
    result.push_str(&pat_str);

    // TODO(ytmimi) comments could appear between `pat` and `=`
    result.push_str(" =");

    let comments_lo = context
        .snippet_provider
        .span_after(expr.span.with_lo(pat.span.hi()), "=");
    let comments_span = mk_sp(comments_lo, expr.span.lo());
    rewrite_assign_rhs_with_comments(
        context,
        result,
        expr,
        shape,
        &RhsAssignKind::Expr(&expr.kind, expr.span),
        RhsTactics::Default,
        comments_span,
        true,
    )
}

pub(crate) fn rewrite_tuple<'a, T: 'a + IntoOverflowableItem<'a>>(
    context: &'a RewriteContext<'_>,
    items: impl Iterator<Item = &'a T>,
    span: Span,
    shape: Shape,
    is_singleton_tuple: bool,
) -> RewriteResult {
    debug!("rewrite_tuple {:?}", shape);
    if context.use_block_indent() {
        // We use the same rule as function calls for rewriting tuples.
        let force_tactic = if context.inside_macro() {
            if span_ends_with_comma(context, span) {
                Some(SeparatorTactic::Always)
            } else {
                Some(SeparatorTactic::Never)
            }
        } else if is_singleton_tuple {
            Some(SeparatorTactic::Always)
        } else {
            None
        };
        overflow::rewrite_with_parens(
            context,
            "",
            items,
            shape,
            span,
            context.config.fn_call_width(),
            force_tactic,
        )
    } else {
        rewrite_tuple_in_visual_indent_style(context, items, span, shape, is_singleton_tuple)
    }
}

pub(crate) fn rewrite_unary_prefix<R: Rewrite + Spanned>(
    context: &RewriteContext<'_>,
    prefix: &str,
    rewrite: &R,
    shape: Shape,
) -> RewriteResult {
    let shape = shape.offset_left(prefix.len(), rewrite.span())?;
    rewrite
        .rewrite_result(context, shape)
        .map(|r| format!("{}{}", prefix, r))
}

// FIXME: this is probably not correct for multi-line Rewrites. we should
// subtract suffix.len() from the last line budget, not the first!
pub(crate) fn rewrite_unary_suffix<R: Rewrite + Spanned>(
    context: &RewriteContext<'_>,
    suffix: &str,
    rewrite: &R,
    shape: Shape,
) -> RewriteResult {
    let shape = shape.sub_width(suffix.len(), rewrite.span())?;
    rewrite.rewrite_result(context, shape).map(|mut r| {
        r.push_str(suffix);
        r
    })
}

fn rewrite_unary_op(
    context: &RewriteContext<'_>,
    op: ast::UnOp,
    expr: &ast::Expr,
    shape: Shape,
) -> RewriteResult {
    // For some reason, an UnOp is not spanned like BinOp!
    rewrite_unary_prefix(context, op.as_str(), expr, shape)
}

pub(crate) enum RhsAssignKind<'ast> {
    Expr(&'ast ast::ExprKind, #[allow(dead_code)] Span),
    Bounds,
    Ty,
}

impl<'ast> RhsAssignKind<'ast> {
    // TODO(calebcartwright)
    // Preemptive addition for handling RHS with chains, not yet utilized.
    // It may make more sense to construct the chain first and then check
    // whether there are actually chain elements.
    #[allow(dead_code)]
    fn is_chain(&self) -> bool {
        match self {
            RhsAssignKind::Expr(kind, _) => {
                matches!(
                    kind,
                    ast::ExprKind::Try(..)
                        | ast::ExprKind::Field(..)
                        | ast::ExprKind::MethodCall(..)
                        | ast::ExprKind::Await(_, _)
                )
            }
            _ => false,
        }
    }
}

fn rewrite_assignment(
    context: &RewriteContext<'_>,
    lhs: &ast::Expr,
    rhs: &ast::Expr,
    op: Option<&ast::AssignOp>,
    shape: Shape,
) -> RewriteResult {
    let operator_str = match op {
        Some(op) => context.snippet(op.span),
        None => "=",
    };

    // 1 = space between lhs and operator.
    let lhs_shape = shape.sub_width(operator_str.len() + 1, lhs.span())?;
    let lhs_str = format!(
        "{} {}",
        lhs.rewrite_result(context, lhs_shape)?,
        operator_str
    );

    rewrite_assign_rhs(
        context,
        lhs_str,
        rhs,
        &RhsAssignKind::Expr(&rhs.kind, rhs.span),
        shape,
    )
}

/// Controls where to put the rhs.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub(crate) enum RhsTactics {
    /// Use heuristics.
    Default,
    /// Put the rhs on the next line if it uses multiple line, without extra indentation.
    ForceNextLineWithoutIndent,
    /// Allow overflowing max width if neither `Default` nor `ForceNextLineWithoutIndent`
    /// did not work.
    AllowOverflow,
}

// The left hand side must contain everything up to, and including, the
// assignment operator.
pub(crate) fn rewrite_assign_rhs<S: Into<String>, R: Rewrite>(
    context: &RewriteContext<'_>,
    lhs: S,
    ex: &R,
    rhs_kind: &RhsAssignKind<'_>,
    shape: Shape,
) -> RewriteResult {
    rewrite_assign_rhs_with(context, lhs, ex, shape, rhs_kind, RhsTactics::Default)
}

pub(crate) fn rewrite_assign_rhs_expr<R: Rewrite>(
    context: &RewriteContext<'_>,
    lhs: &str,
    ex: &R,
    shape: Shape,
    rhs_kind: &RhsAssignKind<'_>,
    rhs_tactics: RhsTactics,
) -> RewriteResult {
    let last_line_width =
        last_line_width(lhs, context.config.tab_spaces()).saturating_sub(if lhs.contains('\n') {
            shape.indent.width()
        } else {
            0
        });
    // 1 = space between operator and rhs.
    let orig_shape = shape.offset_left_opt(last_line_width + 1).unwrap_or(Shape {
        width: 0,
        offset: shape.offset + last_line_width + 1,
        ..shape
    });
    let has_rhs_comment = if let Some(offset) = lhs.find_last_uncommented("=") {
        lhs.trim_end().len() > offset + 1
    } else {
        false
    };

    choose_rhs(
        context,
        ex,
        orig_shape,
        ex.rewrite_result(context, orig_shape),
        rhs_kind,
        rhs_tactics,
        has_rhs_comment,
    )
}

pub(crate) fn rewrite_assign_rhs_with<S: Into<String>, R: Rewrite>(
    context: &RewriteContext<'_>,
    lhs: S,
    ex: &R,
    shape: Shape,
    rhs_kind: &RhsAssignKind<'_>,
    rhs_tactics: RhsTactics,
) -> RewriteResult {
    let lhs = lhs.into();
    let rhs = rewrite_assign_rhs_expr(context, &lhs, ex, shape, rhs_kind, rhs_tactics)?;
    Ok(lhs + &rhs)
}

pub(crate) fn rewrite_assign_rhs_with_comments<S: Into<String>, R: Rewrite + Spanned>(
    context: &RewriteContext<'_>,
    lhs: S,
    ex: &R,
    shape: Shape,
    rhs_kind: &RhsAssignKind<'_>,
    rhs_tactics: RhsTactics,
    between_span: Span,
    allow_extend: bool,
) -> RewriteResult {
    let lhs = lhs.into();
    let contains_comment = contains_comment(context.snippet(between_span));
    let shape = if contains_comment {
        shape.block_left(
            context.config.tab_spaces(),
            between_span.with_hi(ex.span().hi()),
        )?
    } else {
        shape
    };
    let rhs = rewrite_assign_rhs_expr(context, &lhs, ex, shape, rhs_kind, rhs_tactics)?;
    if contains_comment {
        let rhs = rhs.trim_start();
        combine_strs_with_missing_comments(context, &lhs, rhs, between_span, shape, allow_extend)
    } else {
        Ok(lhs + &rhs)
    }
}

fn choose_rhs<R: Rewrite>(
    context: &RewriteContext<'_>,
    expr: &R,
    shape: Shape,
    orig_rhs: RewriteResult,
    _rhs_kind: &RhsAssignKind<'_>,
    rhs_tactics: RhsTactics,
    has_rhs_comment: bool,
) -> RewriteResult {
    match orig_rhs {
        Ok(ref new_str) if new_str.is_empty() => Ok(String::new()),
        Ok(ref new_str) if !new_str.contains('\n') && unicode_str_width(new_str) <= shape.width => {
            Ok(format!(" {new_str}"))
        }
        _ => {
            // Expression did not fit on the same line as the identifier.
            // Try splitting the line and see if that works better.
            let new_shape = shape_from_rhs_tactic(context, shape, rhs_tactics)
                // TODO(ding-young) Ideally, we can replace unknown_error() with max_width_error(),
                // but this requires either implementing the Spanned trait for ast::GenericBounds
                // or grabbing the span from the call site.
                .unknown_error()?;
            let new_rhs = expr.rewrite_result(context, new_shape);
            let new_indent_str = &shape
                .indent
                .block_indent(context.config)
                .to_string_with_newline(context.config);
            let before_space_str = if has_rhs_comment { "" } else { " " };

            match (orig_rhs, new_rhs) {
                (Ok(ref orig_rhs), Ok(ref new_rhs))
                    if !filtered_str_fits(
                        &new_rhs,
                        context.config.max_width(),
                        context.config.tab_spaces(),
                        new_shape,
                    ) =>
                {
                    Ok(format!("{before_space_str}{orig_rhs}"))
                }
                (Ok(ref orig_rhs), Ok(ref new_rhs))
                    if prefer_next_line(orig_rhs, new_rhs, rhs_tactics) =>
                {
                    Ok(format!("{new_indent_str}{new_rhs}"))
                }
                (Err(_), Ok(ref new_rhs)) => Ok(format!("{new_indent_str}{new_rhs}")),
                (Err(_), Err(_)) if rhs_tactics == RhsTactics::AllowOverflow => {
                    let shape = shape.infinite_width();
                    expr.rewrite_result(context, shape)
                        .map(|s| format!("{}{}", before_space_str, s))
                }
                // When both orig_rhs and new_rhs result in errors, we currently propagate
                // the error from the second attempt since it is more generous with
                // width constraints. This decision is somewhat arbitrary and is open to change.
                (Err(_), Err(new_rhs_err)) => Err(new_rhs_err),
                (Ok(orig_rhs), _) => Ok(format!("{before_space_str}{orig_rhs}")),
            }
        }
    }
}

fn shape_from_rhs_tactic(
    context: &RewriteContext<'_>,
    shape: Shape,
    rhs_tactic: RhsTactics,
) -> Option<Shape> {
    match rhs_tactic {
        RhsTactics::ForceNextLineWithoutIndent => shape
            .with_max_width(context.config)
            .sub_width_opt(shape.indent.width()),
        RhsTactics::Default | RhsTactics::AllowOverflow => {
            Shape::indented(shape.indent.block_indent(context.config), context.config)
                .sub_width_opt(shape.rhs_overhead(context.config))
        }
    }
}

/// Returns true if formatting next_line_rhs is better on a new line when compared to the
/// original's line formatting.
///
/// It is considered better if:
/// 1. the tactic is ForceNextLineWithoutIndent
/// 2. next_line_rhs doesn't have newlines
/// 3. the original line has more newlines than next_line_rhs
/// 4. the original formatting of the first line ends with `(`, `{`, or `[` and next_line_rhs
///    doesn't
pub(crate) fn prefer_next_line(
    orig_rhs: &str,
    next_line_rhs: &str,
    rhs_tactics: RhsTactics,
) -> bool {
    rhs_tactics == RhsTactics::ForceNextLineWithoutIndent
        || !next_line_rhs.contains('\n')
        || count_newlines(orig_rhs) > count_newlines(next_line_rhs) + 1
        || first_line_ends_with(orig_rhs, '(') && !first_line_ends_with(next_line_rhs, '(')
        || first_line_ends_with(orig_rhs, '{') && !first_line_ends_with(next_line_rhs, '{')
        || first_line_ends_with(orig_rhs, '[') && !first_line_ends_with(next_line_rhs, '[')
}

fn rewrite_expr_addrof(
    context: &RewriteContext<'_>,
    borrow_kind: ast::BorrowKind,
    mutability: ast::Mutability,
    expr: &ast::Expr,
    shape: Shape,
) -> RewriteResult {
    let operator_str = match (mutability, borrow_kind) {
        (ast::Mutability::Not, ast::BorrowKind::Ref) => "&",
        (ast::Mutability::Not, ast::BorrowKind::Pin) => "&pin const ",
        (ast::Mutability::Not, ast::BorrowKind::Raw) => "&raw const ",
        (ast::Mutability::Mut, ast::BorrowKind::Ref) => "&mut ",
        (ast::Mutability::Mut, ast::BorrowKind::Pin) => "&pin mut ",
        (ast::Mutability::Mut, ast::BorrowKind::Raw) => "&raw mut ",
    };
    rewrite_unary_prefix(context, operator_str, expr, shape)
}

pub(crate) fn is_method_call(expr: &ast::Expr) -> bool {
    match expr.kind {
        ast::ExprKind::MethodCall(..) => true,
        ast::ExprKind::AddrOf(_, _, ref expr)
        | ast::ExprKind::Cast(ref expr, _)
        | ast::ExprKind::Try(ref expr)
        | ast::ExprKind::Unary(_, ref expr) => is_method_call(expr),
        _ => false,
    }
}

/// Indicates the parts of a float literal specified as a string.
struct FloatSymbolParts<'a> {
    /// The integer part, e.g. `123` in `123.456e789`.
    /// Always non-empty, because in Rust `.1` is not a valid floating-point literal:
    /// <https://doc.rust-lang.org/reference/tokens.html#floating-point-literals>
    integer_part: &'a str,
    /// The fractional part excluding the decimal point, e.g. `456` in `123.456e789`.
    fractional_part: Option<&'a str>,
    /// The exponent part including the `e` or `E`, e.g. `e789` in `123.456e789`.
    exponent: Option<&'a str>,
}

impl FloatSymbolParts<'_> {
    fn is_fractional_part_zero(&self) -> bool {
        let zero_literal_regex = static_regex!(r"^[0_]+$");
        self.fractional_part
            .is_none_or(|s| zero_literal_regex.is_match(s))
    }
}

/// Parses a float literal. The `symbol` must be a valid floating point literal without a type
/// suffix. Otherwise the function may panic or return wrong result.
fn parse_float_symbol(symbol: &str) -> Result<FloatSymbolParts<'_>, &'static str> {
    // This regex may accept invalid float literals (such as `1`, `_` or `2.e3`). That's ok.
    // We only use it to parse literals whose validity has already been established.
    let float_literal_regex = static_regex!(r"^([0-9_]+)(?:\.([0-9_]+)?)?([eE][+-]?[0-9_]+)?$");
    let caps = float_literal_regex
        .captures(symbol)
        .ok_or("invalid float literal")?;
    Ok(FloatSymbolParts {
        integer_part: caps.get(1).ok_or("missing integer part")?.as_str(),
        fractional_part: caps.get(2).map(|m| m.as_str()),
        exponent: caps.get(3).map(|m| m.as_str()),
    })
}

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

    #[test]
    fn test_last_line_offsetted() {
        let lines = "one\n    two";
        assert_eq!(last_line_offsetted(2, lines), true);
        assert_eq!(last_line_offsetted(4, lines), false);
        assert_eq!(last_line_offsetted(6, lines), false);

        let lines = "one    two";
        assert_eq!(last_line_offsetted(2, lines), false);
        assert_eq!(last_line_offsetted(0, lines), false);

        let lines = "\ntwo";
        assert_eq!(last_line_offsetted(2, lines), false);
        assert_eq!(last_line_offsetted(0, lines), false);

        let lines = "one\n    two      three";
        assert_eq!(last_line_offsetted(2, lines), true);
        let lines = "one\n two      three";
        assert_eq!(last_line_offsetted(2, lines), false);
    }

    #[test]
    fn test_parse_float_symbol() {
        let parts = parse_float_symbol("123.456e789").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, Some("456"));
        assert_eq!(parts.exponent, Some("e789"));

        let parts = parse_float_symbol("123.456e+789").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, Some("456"));
        assert_eq!(parts.exponent, Some("e+789"));

        let parts = parse_float_symbol("123.456e-789").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, Some("456"));
        assert_eq!(parts.exponent, Some("e-789"));

        let parts = parse_float_symbol("123e789").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, None);
        assert_eq!(parts.exponent, Some("e789"));

        let parts = parse_float_symbol("123E789").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, None);
        assert_eq!(parts.exponent, Some("E789"));

        let parts = parse_float_symbol("123.").unwrap();
        assert_eq!(parts.integer_part, "123");
        assert_eq!(parts.fractional_part, None);
        assert_eq!(parts.exponent, None);
    }

    #[test]
    fn test_parse_float_symbol_with_underscores() {
        let parts = parse_float_symbol("_123._456e_789").unwrap();
        assert_eq!(parts.integer_part, "_123");
        assert_eq!(parts.fractional_part, Some("_456"));
        assert_eq!(parts.exponent, Some("e_789"));

        let parts = parse_float_symbol("123_.456_e789_").unwrap();
        assert_eq!(parts.integer_part, "123_");
        assert_eq!(parts.fractional_part, Some("456_"));
        assert_eq!(parts.exponent, Some("e789_"));

        let parts = parse_float_symbol("1_23.4_56e7_89").unwrap();
        assert_eq!(parts.integer_part, "1_23");
        assert_eq!(parts.fractional_part, Some("4_56"));
        assert_eq!(parts.exponent, Some("e7_89"));

        let parts = parse_float_symbol("_1_23_._4_56_e_7_89_").unwrap();
        assert_eq!(parts.integer_part, "_1_23_");
        assert_eq!(parts.fractional_part, Some("_4_56_"));
        assert_eq!(parts.exponent, Some("e_7_89_"));
    }

    #[test]
    fn test_float_lit_ends_in_dot() {
        type TZ = FloatLiteralTrailingZero;

        assert!(float_lit_ends_in_dot("1.", None, TZ::Preserve));
        assert!(!float_lit_ends_in_dot("1.0", None, TZ::Preserve));
        assert!(!float_lit_ends_in_dot("1.e2", None, TZ::Preserve));
        assert!(!float_lit_ends_in_dot("1.0e2", None, TZ::Preserve));
        assert!(!float_lit_ends_in_dot("1.", Some("f32"), TZ::Preserve));
        assert!(!float_lit_ends_in_dot("1.0", Some("f32"), TZ::Preserve));

        assert!(!float_lit_ends_in_dot("1.", None, TZ::Always));
        assert!(!float_lit_ends_in_dot("1.0", None, TZ::Always));
        assert!(!float_lit_ends_in_dot("1.e2", None, TZ::Always));
        assert!(!float_lit_ends_in_dot("1.0e2", None, TZ::Always));
        assert!(!float_lit_ends_in_dot("1.", Some("f32"), TZ::Always));
        assert!(!float_lit_ends_in_dot("1.0", Some("f32"), TZ::Always));

        assert!(!float_lit_ends_in_dot("1.", None, TZ::IfNoPostfix));
        assert!(!float_lit_ends_in_dot("1.0", None, TZ::IfNoPostfix));
        assert!(!float_lit_ends_in_dot("1.e2", None, TZ::IfNoPostfix));
        assert!(!float_lit_ends_in_dot("1.0e2", None, TZ::IfNoPostfix));
        assert!(!float_lit_ends_in_dot("1.", Some("f32"), TZ::IfNoPostfix));
        assert!(!float_lit_ends_in_dot("1.0", Some("f32"), TZ::IfNoPostfix));

        assert!(float_lit_ends_in_dot("1.", None, TZ::Never));
        assert!(float_lit_ends_in_dot("1.0", None, TZ::Never));
        assert!(!float_lit_ends_in_dot("1.e2", None, TZ::Never));
        assert!(!float_lit_ends_in_dot("1.0e2", None, TZ::Never));
        assert!(!float_lit_ends_in_dot("1.", Some("f32"), TZ::Never));
        assert!(!float_lit_ends_in_dot("1.0", Some("f32"), TZ::Never));
    }
}