forge_fmt/state/

common.rs

use super::{CommentConfig, Separator, State};
use crate::pp::{BreakToken, Printer, SIZE_INFINITY};
use foundry_common::iter::IterDelimited;
use foundry_config::fmt as config;
use itertools::{Either, Itertools};
use solar::parse::{
    Cursor,
    ast::{self, Span},
    interface::BytePos,
};
use std::{borrow::Cow, fmt::Debug};

pub(crate) trait LitExt<'ast> {
    fn is_str_concatenation(&self) -> bool;
}

impl<'ast> LitExt<'ast> for ast::Lit<'ast> {
    /// Checks if a the input literal is a string literal with multiple parts.
    fn is_str_concatenation(&self) -> bool {
        if let ast::LitKind::Str(_, _, parts) = &self.kind { !parts.is_empty() } else { false }
    }
}

/// Language-specific pretty printing. Common for both: Solidity + Yul.
impl<'ast> State<'_, 'ast> {
    pub(super) fn print_lit_inner(&mut self, lit: &'ast ast::Lit<'ast>, is_yul: bool) {
        let ast::Lit { span, symbol, ref kind } = *lit;
        if self.handle_span(span, false) {
            return;
        }

        match *kind {
            ast::LitKind::Str(kind, ..) => {
                self.s.ibox(0);
                for (pos, (span, symbol)) in lit.literals().delimited() {
                    if !self.handle_span(span, false) {
                        let quote_pos = span.lo() + kind.prefix().len() as u32;
                        self.print_str_lit(kind, quote_pos, symbol.as_str());
                    }
                    if pos.is_last {
                        self.neverbreak();
                    } else {
                        if !self.print_trailing_comment(span.hi(), None) {
                            self.space_if_not_bol();
                        }
                    }
                }
                self.end();
            }
            ast::LitKind::Number(_) | ast::LitKind::Rational(_) => {
                self.print_num_literal(symbol.as_str(), is_yul);
            }
            ast::LitKind::Address(value) => self.word(value.to_string()),
            ast::LitKind::Bool(value) => self.word(if value { "true" } else { "false" }),
            ast::LitKind::Err(_) => self.word(symbol.to_string()),
        }
    }

    fn print_num_literal(&mut self, source: &str, is_yul: bool) {
        fn strip_underscores_if(b: bool, s: &str) -> Cow<'_, str> {
            if b && s.contains('_') { Cow::Owned(s.replace('_', "")) } else { Cow::Borrowed(s) }
        }

        fn add_underscores(
            out: &mut String,
            config: config::NumberUnderscore,
            string: &str,
            is_dec: bool,
            is_yul: bool,
            reversed: bool,
        ) {
            // The underscore thousand separator is only valid in Solidity decimal numbers.
            // It is not supported by hex numbers, nor Yul literals.
            // https://github.com/foundry-rs/foundry/issues/12111
            if !config.is_thousands() || !is_dec || is_yul || string.len() < 5 {
                out.push_str(string);
                return;
            }

            let chunks = if reversed {
                Either::Left(string.as_bytes().chunks(3))
            } else {
                Either::Right(string.as_bytes().rchunks(3).rev())
            }
            .map(|chunk| std::str::from_utf8(chunk).unwrap());
            for chunk in Itertools::intersperse(chunks, "_") {
                out.push_str(chunk);
            }
        }

        debug_assert!(source.is_ascii(), "{source:?}");

        let config = self.config.number_underscore;
        let is_dec = !["0x", "0b", "0o"].iter().any(|prefix| source.starts_with(prefix));

        let (val, exp) = if is_dec {
            source.split_once(['e', 'E']).unwrap_or((source, ""))
        } else {
            (source, "")
        };
        let (val, fract) = val.split_once('.').unwrap_or((val, ""));

        let strip_underscores = !config.is_preserve() || is_yul;
        let mut val = &strip_underscores_if(strip_underscores, val)[..];
        let mut exp = &strip_underscores_if(strip_underscores, exp)[..];
        let mut fract = &strip_underscores_if(strip_underscores, fract)[..];

        // strip any padded 0's
        let mut exp_sign = "";
        if is_dec {
            val = val.trim_start_matches('0');
            fract = fract.trim_end_matches('0');
            (exp_sign, exp) =
                if let Some(exp) = exp.strip_prefix('-') { ("-", exp) } else { ("", exp) };
            exp = exp.trim_start_matches('0');
        }

        let mut out = String::with_capacity(source.len() * 2);
        if val.is_empty() {
            out.push('0');
        } else {
            add_underscores(&mut out, config, val, is_dec, is_yul, false);
        }
        if source.contains('.') {
            out.push('.');
            match (fract.is_empty(), exp.is_empty()) {
                // `X.YeZ`: keep as is
                (false, false) => out.push_str(fract),
                // `X.Y`
                (false, true) => add_underscores(&mut out, config, fract, is_dec, is_yul, true),
                // `X.` -> `X.0`
                (true, _) => out.push('0'),
            };
        }
        if !exp.is_empty() {
            out.push('e');
            out.push_str(exp_sign);
            add_underscores(&mut out, config, exp, is_dec, is_yul, false);
        }

        self.word(out);
    }

    /// `s` should be the *unescaped contents of the string literal*.
    pub(super) fn print_str_lit(&mut self, kind: ast::StrKind, quote_pos: BytePos, s: &str) {
        self.print_comments(quote_pos, CommentConfig::default());
        let s = self.str_lit_to_string(kind, quote_pos, s);
        self.word(s);
    }

    /// `s` should be the *unescaped contents of the string literal*.
    fn str_lit_to_string(&self, kind: ast::StrKind, quote_pos: BytePos, s: &str) -> String {
        let prefix = kind.prefix();
        let quote = match self.config.quote_style {
            config::QuoteStyle::Double => '\"',
            config::QuoteStyle::Single => '\'',
            config::QuoteStyle::Preserve => self.char_at(quote_pos).unwrap_or_default(),
        };
        debug_assert!(matches!(quote, '\"' | '\''), "{quote:?}");
        let s = solar::parse::interface::data_structures::fmt::from_fn(move |f| {
            if matches!(kind, ast::StrKind::Hex) {
                match self.config.hex_underscore {
                    config::HexUnderscore::Preserve => {}
                    config::HexUnderscore::Remove | config::HexUnderscore::Bytes => {
                        let mut clean = s.to_string().replace('_', "");
                        if matches!(self.config.hex_underscore, config::HexUnderscore::Bytes) {
                            clean =
                                clean.chars().chunks(2).into_iter().map(|c| c.format("")).join("_");
                        }
                        return f.write_str(&clean);
                    }
                };
            }
            f.write_str(s)
        });
        let mut s = format!("{prefix}{quote}{s}{quote}");

        // If the output is not a single token then revert to the original quote.
        #[allow(unstable_name_collisions)]
        if Cursor::new(&s).exactly_one().is_err() {
            let other_quote = if quote == '\"' { '\'' } else { '\"' };
            {
                let s = unsafe { s.as_bytes_mut() };
                s[prefix.len()] = other_quote as u8;
                s[s.len() - 1] = other_quote as u8;
            }
            debug_assert!(Cursor::new(&s).exactly_one().map(|_| true).unwrap());
        }

        s
    }

    pub(super) fn print_tuple_empty(&mut self, pos_lo: BytePos, pos_hi: BytePos) {
        if self.handle_span(Span::new(pos_lo, pos_hi), true) {
            return;
        }

        self.print_inside_parens(|state| {
            state.s.cbox(state.ind);
            if let Some(cmnt) =
                state.print_comments(pos_hi, CommentConfig::skip_ws().mixed_prev_space())
            {
                if cmnt.is_mixed() {
                    state.s.offset(-state.ind);
                } else {
                    state.break_offset_if_not_bol(0, -state.ind, false);
                }
            }
            state.end();
        });
    }

    pub(super) fn print_tuple<'a, T, P, S>(
        &mut self,
        values: &'a [T],
        pos_lo: BytePos,
        pos_hi: BytePos,
        mut print: P,
        mut get_span: S,
        format: ListFormat,
    ) where
        P: FnMut(&mut Self, &'a T),
        S: FnMut(&T) -> Span,
    {
        if self.handle_span(Span::new(pos_lo, pos_hi), true) {
            return;
        }

        if values.is_empty() {
            self.print_tuple_empty(pos_lo, pos_hi);
            return;
        }

        if !(values.len() == 1 && format.is_inline()) {
            // Use commasep
            self.print_inside_parens(|state| {
                state.commasep(values, pos_lo, pos_hi, print, get_span, format)
            });
            return;
        }

        // Format single-item inline lists directly without boxes
        self.print_inside_parens(|state| {
            let span = get_span(&values[0]);
            state.s.cbox(state.ind);
            let mut skip_break = true;
            if state.peek_comment_before(span.hi()).is_some() {
                state.hardbreak();
                skip_break = false;
            }

            state.print_comments(span.lo(), CommentConfig::skip_ws().mixed_prev_space());
            print(state, &values[0]);

            if !state.print_trailing_comment(span.hi(), None) && skip_break {
                state.neverbreak();
            } else {
                state.break_offset_if_not_bol(0, -state.ind, false);
            }
            state.end();
        });
    }

    pub(super) fn print_array<'a, T, P, S>(
        &mut self,
        values: &'a [T],
        span: Span,
        print: P,
        get_span: S,
    ) where
        P: FnMut(&mut Self, &'a T),
        S: FnMut(&T) -> Span,
    {
        if self.handle_span(span, false) {
            return;
        }

        self.print_word("[");
        self.commasep(values, span.lo(), span.hi(), print, get_span, ListFormat::compact());
        self.print_word("]");
    }

    pub(super) fn commasep_opening_logic<T, S>(
        &mut self,
        values: &[T],
        mut get_span: S,
        format: ListFormat,
        manual_opening: bool,
    ) -> bool
    where
        S: FnMut(&T) -> Span,
    {
        let Some(span) = values.first().map(&mut get_span) else {
            return false;
        };

        // If first item is uninformed (just a comma), and it has its own comment, skip it.
        // It will be dealt with when printing the item in the main loop of `commasep`.
        if span.is_dummy()
            && let Some(next_pos) = values.get(1).map(|v| get_span(v).lo())
            && self.peek_comment_before(next_pos).is_some()
        {
            return true;
        }

        // Check for comments before the first item.
        if let Some((cmnt_span, cmnt_style)) =
            self.peek_comment_before(span.lo()).map(|c| (c.span, c.style))
        {
            let cmnt_disabled = self.inline_config.is_disabled(cmnt_span);
            // Handle special formatting for disabled code with isolated comments.
            if self.cursor.enabled && cmnt_disabled && cmnt_style.is_isolated() {
                self.print_sep(Separator::Hardbreak);
                if !format.with_delimiters {
                    self.s.offset(self.ind);
                }
            };

            // If manual opening flag is passed, we simply force the break, and skip the comment.
            // It will be dealt with when printing the item in the main loop of `commasep`.
            if manual_opening {
                self.hardbreak();
                self.s.offset(self.ind);
                return true;
            }

            let cmnt_config = if format.with_delimiters {
                CommentConfig::skip_ws().mixed_no_break().mixed_prev_space()
            } else {
                CommentConfig::skip_ws().no_breaks().mixed_prev_space().offset(self.ind)
            };
            // Apply spacing based on comment styles.
            if let Some(last_style) = self.print_comments(span.lo(), cmnt_config) {
                match (cmnt_style.is_mixed(), last_style.is_mixed()) {
                    (true, true) => {
                        if format.breaks_cmnts {
                            self.hardbreak();
                        } else {
                            self.space();
                        }
                        if !format.with_delimiters && !cmnt_disabled {
                            self.s.offset(self.ind);
                        }
                    }
                    (false, true) => {
                        self.nbsp();
                    }
                    (false, false) if !format.with_delimiters && !cmnt_disabled => {
                        self.hardbreak();
                        self.s.offset(self.ind);
                    }
                    _ => {}
                }
            }
            if self.cursor.enabled {
                self.cursor.advance_to(span.lo(), true);
            }
            return true;
        }

        if self.cursor.enabled {
            self.cursor.advance_to(span.lo(), true);
        }

        if !values.is_empty() && !format.with_delimiters {
            format.print_break(true, values.len(), &mut self.s);
            self.s.offset(self.ind);
            return true;
        }

        false
    }

    pub(super) fn commasep<'a, T, P, S>(
        &mut self,
        values: &'a [T],
        _pos_lo: BytePos,
        pos_hi: BytePos,
        mut print: P,
        mut get_span: S,
        format: ListFormat,
    ) where
        P: FnMut(&mut Self, &'a T),
        S: FnMut(&T) -> Span,
    {
        if values.is_empty() {
            return;
        }

        // We can't simply check `peek_comment_before(pos_hi)` cause we would also account for
        // comments in the child expression, and those don't matter.
        let has_comments =
            // check for comments before the first element
            self.peek_comment_before(get_span(&values[0]).lo()).is_some() ||
            // check for comments between elements
            values.windows(2).any(|w| self.peek_comment_between(get_span(&w[0]).hi(), get_span(&w[1]).lo()).is_some()) ||
            // check for comments after the last element
            self.peek_comment_between(get_span(values.last().unwrap()).hi(), pos_hi).is_some();

        // For calls with opts and args, which should break consistently, we need to skip the
        // wrapping cbox to prioritize call args breaking before the call opts. Because of that, we
        // must manually offset the breaks between args, so that they are properly indented.
        let manual_opening =
            format.is_consistent() && !format.with_delimiters && self.call_with_opts_and_args;
        // When there are comments, we can preserve the cbox, as they will make it break
        let manual_offset = !has_comments && manual_opening;

        let is_single_without_cmnts = values.len() == 1 && !format.break_single && !has_comments;
        let skip_first_break = if format.with_delimiters || format.is_inline() {
            self.s.cbox(if format.no_ind { 0 } else { self.ind });
            if is_single_without_cmnts {
                true
            } else {
                self.commasep_opening_logic(values, &mut get_span, format, manual_opening)
            }
        } else {
            let res = self.commasep_opening_logic(values, &mut get_span, format, manual_opening);
            if !manual_offset {
                self.s.cbox(if format.no_ind { 0 } else { self.ind });
            }
            res
        };

        if let Some(sym) = format.prev_symbol() {
            self.word_space(sym);
        } else if is_single_without_cmnts && format.with_space {
            self.nbsp();
        } else if !skip_first_break && !format.is_inline() {
            format.print_break(true, values.len(), &mut self.s);
            if manual_offset {
                self.s.offset(self.ind);
            }
        }

        if format.is_compact() && !(format.breaks_with_comments() && has_comments) {
            self.s.cbox(0);
        }

        let mut last_delimiter_break = !format.with_delimiters;
        let mut skip_last_break =
            is_single_without_cmnts || !format.with_delimiters || format.is_inline();
        for (i, value) in values.iter().enumerate() {
            let is_last = i == values.len() - 1;
            if self
                .print_comments(get_span(value).lo(), CommentConfig::skip_ws().mixed_prev_space())
                .is_some_and(|cmnt| cmnt.is_mixed())
                && format.breaks_cmnts
            {
                self.hardbreak(); // trailing and isolated comments already hardbreak
            }

            // Avoid printing the last uninformed item, so that we can handle line breaks.
            if !(is_last && get_span(value).is_dummy()) {
                print(self, value);
            }

            let next_span = if is_last { None } else { Some(get_span(&values[i + 1])) };
            let next_pos = next_span.map(Span::lo).unwrap_or(pos_hi);
            let cmnt_before_next =
                self.peek_comment_before(next_pos).map(|cmnt| (cmnt.span, cmnt.style));

            if !is_last {
                // Handle disabled lines with comments after the value, but before the comma.
                if cmnt_before_next.is_some_and(|(cmnt_span, _)| {
                    let span = self.cursor.span(cmnt_span.lo());
                    self.inline_config.is_disabled(span)
                        // NOTE: necessary workaround to patch this edgecase due to lack of spans for the commas.
                        && self.sm.span_to_snippet(span).is_ok_and(|snip| !snip.contains(','))
                }) {
                    self.print_comments(
                        next_pos,
                        CommentConfig::skip_ws().mixed_no_break().mixed_prev_space(),
                    );
                }
                self.print_word(",");
            }

            if !is_last
                && format.breaks_cmnts
                && cmnt_before_next.is_some_and(|(cmnt_span, cmnt_style)| {
                    let disabled = self.inline_config.is_disabled(cmnt_span);
                    (cmnt_style.is_mixed() && !disabled) || (cmnt_style.is_isolated() && disabled)
                })
            {
                self.hardbreak(); // trailing and isolated comments already hardbreak
            }

            // Print trailing comments.
            let comment_config = if !is_last || format.with_delimiters {
                CommentConfig::skip_ws().mixed_no_break().mixed_prev_space()
            } else {
                CommentConfig::skip_ws().no_breaks().mixed_prev_space()
            };
            let with_trailing = self.print_comments(next_pos, comment_config).is_some();

            if is_last && with_trailing {
                if self.is_bol_or_only_ind() {
                    // if a trailing comment is printed at the very end, we have to manually adjust
                    // the offset to avoid having a double break.
                    self.break_offset_if_not_bol(0, -self.ind, false);
                } else {
                    self.s.break_offset(SIZE_INFINITY as usize, -self.ind);
                }
                skip_last_break = true;
                last_delimiter_break = false;
            }

            // Final break if needed before the next value.
            if let Some(next_span) = next_span
                && !self.is_bol_or_only_ind()
                && !self.inline_config.is_disabled(next_span)
                && !next_span.is_dummy()
            {
                format.print_break(false, values.len(), &mut self.s);
                if manual_offset {
                    self.s.offset(self.ind);
                }
            }
        }

        if format.is_compact() && !(format.breaks_with_comments() && has_comments) {
            self.end();
        }
        if !skip_last_break {
            if let Some(sym) = format.post_symbol() {
                format.print_break(false, values.len(), &mut self.s);
                self.s.offset(-self.ind);
                self.word(sym);
            } else {
                format.print_break(true, values.len(), &mut self.s);
                self.s.offset(-self.ind);
            }
        } else if is_single_without_cmnts && format.with_space {
            self.nbsp();
        } else if let Some(sym) = format.post_symbol() {
            self.nbsp();
            self.word(sym);
        }

        if !manual_offset {
            self.end();
        }
        self.cursor.advance_to(pos_hi, true);

        if last_delimiter_break {
            format.print_break(true, values.len(), &mut self.s);
        }
    }

    pub(super) fn print_path(&mut self, path: &'ast ast::PathSlice, consistent_break: bool) {
        if consistent_break {
            self.s.cbox(self.ind);
        } else {
            self.s.ibox(self.ind);
        }
        for (pos, ident) in path.segments().iter().delimited() {
            self.print_ident(ident);
            if !pos.is_last {
                if !self.emit_or_revert {
                    self.zerobreak();
                }
                self.word(".");
            }
        }
        self.end();
    }

    pub(super) fn print_block_inner<T: Debug>(
        &mut self,
        block: &'ast [T],
        block_format: BlockFormat,
        mut print: impl FnMut(&mut Self, &'ast T),
        mut get_block_span: impl FnMut(&'ast T) -> Span,
        pos_hi: BytePos,
    ) {
        // Attempt to print in a single line.
        if block_format.attempt_single_line() && block.len() == 1 {
            self.print_single_line_block(block, block_format, print, get_block_span);
            return;
        }

        // Empty blocks with comments require special attention.
        if block.is_empty() {
            self.print_empty_block(block_format, pos_hi);
            return;
        }

        // update block depth
        self.block_depth += 1;

        // Print multiline block comments.
        let block_lo = get_block_span(&block[0]).lo();
        match block_format {
            BlockFormat::NoBraces(None) => {
                if !self.handle_span(self.cursor.span(block_lo), false) {
                    self.print_comments(block_lo, CommentConfig::default());
                }
                self.s.cbox(0);
            }
            BlockFormat::NoBraces(Some(offset)) => {
                let enabled =
                    !self.inline_config.is_disabled(Span::new(block_lo, block_lo + BytePos(1)))
                        && !self.handle_span(self.cursor.span(block_lo), true);
                match self
                    .peek_comment()
                    .and_then(|cmnt| (cmnt.span.hi() < block_lo).then_some((cmnt.span, cmnt.style)))
                {
                    Some((span, style)) => {
                        if enabled {
                            // Inline config is not disabled and span not handled
                            if !self.inline_config.is_disabled(span) || style.is_isolated() {
                                self.cursor.advance_to(span.lo(), true);
                                self.break_offset(SIZE_INFINITY as usize, offset);
                            }
                            if let Some(cmnt) = self.print_comments(
                                block_lo,
                                CommentConfig::skip_leading_ws(false).offset(offset),
                            ) && !cmnt.is_mixed()
                                && !cmnt.is_blank()
                            {
                                self.s.offset(offset);
                            }
                        } else if style.is_isolated() {
                            self.print_sep_unhandled(Separator::Hardbreak);
                            self.s.offset(offset);
                        }
                    }
                    None => {
                        if enabled {
                            self.zerobreak();
                            self.s.offset(offset);
                        } else if self.cursor.enabled {
                            self.print_sep_unhandled(Separator::Space);
                            self.s.offset(offset);
                            self.cursor.advance_to(block_lo, true);
                        }
                    }
                }
                self.s.cbox(self.ind);
            }
            _ => {
                self.print_word("{");
                self.s.cbox(self.ind);
                if !self.handle_span(self.cursor.span(block_lo), false)
                    && self
                        .print_comments(block_lo, CommentConfig::default())
                        .is_none_or(|cmnt| cmnt.is_mixed())
                {
                    self.hardbreak_if_nonempty();
                }
            }
        }

        // Print multiline block statements.
        for (i, stmt) in block.iter().enumerate() {
            let is_last = i == block.len() - 1;
            print(self, stmt);

            let is_disabled = self.inline_config.is_disabled(get_block_span(stmt));
            let mut next_enabled = false;
            let mut next_lo = None;
            if !is_last {
                let next_span = get_block_span(&block[i + 1]);
                next_enabled = !self.inline_config.is_disabled(next_span);
                next_lo =
                    self.peek_comment_before(next_span.lo()).is_none().then_some(next_span.lo());
            }

            // when this stmt and the next one are enabled, break normally (except if last stmt)
            if !is_disabled
                && next_enabled
                && (!is_last
                    || self.peek_comment_before(pos_hi).is_some_and(|cmnt| cmnt.style.is_mixed()))
            {
                self.hardbreak_if_not_bol();
                continue;
            }
            // when this stmt is disabled and the next one is enabled, break if there is no
            // enabled preceding comment. Otherwise the breakpoint is handled by the comment.
            if is_disabled
                && next_enabled
                && let Some(next_lo) = next_lo
                && self
                    .peek_comment_before(next_lo)
                    .is_none_or(|cmnt| self.inline_config.is_disabled(cmnt.span))
            {
                self.hardbreak_if_not_bol()
            }
        }

        self.print_comments(
            pos_hi,
            CommentConfig::skip_trailing_ws().mixed_no_break().mixed_prev_space(),
        );
        if !block_format.breaks() {
            if !self.last_token_is_break() {
                self.hardbreak();
            }
            self.s.offset(-self.ind);
        }
        self.end();
        if block_format.with_braces() {
            self.print_word("}");
        }

        // restore block depth
        self.block_depth -= 1;
    }

    fn print_single_line_block<T: Debug>(
        &mut self,
        block: &'ast [T],
        block_format: BlockFormat,
        mut print: impl FnMut(&mut Self, &'ast T),
        mut get_block_span: impl FnMut(&'ast T) -> Span,
    ) {
        self.s.cbox(self.ind);

        match block_format {
            BlockFormat::Compact(true) => {
                self.scan_break(BreakToken { pre_break: Some("{"), ..Default::default() });
                print(self, &block[0]);
                self.print_comments(get_block_span(&block[0]).hi(), CommentConfig::default());
                self.s.scan_break(BreakToken { post_break: Some("}"), ..Default::default() });
                self.s.offset(-self.ind);
            }
            _ => {
                self.word("{");
                self.space();
                print(self, &block[0]);
                self.print_comments(get_block_span(&block[0]).hi(), CommentConfig::default());
                self.space_if_not_bol();
                self.s.offset(-self.ind);
                self.word("}");
            }
        }

        self.end();
    }

    fn print_empty_block(&mut self, block_format: BlockFormat, pos_hi: BytePos) {
        let has_braces = block_format.with_braces();

        // Trailing comments are printed after the block
        if self.peek_comment_before(pos_hi).is_none_or(|c| c.style.is_trailing()) {
            if self.config.bracket_spacing {
                if has_braces {
                    self.word("{ }");
                } else {
                    self.nbsp();
                }
            } else if has_braces {
                self.word("{}");
            }
            self.print_comments(pos_hi, CommentConfig::skip_ws());
            return;
        }

        // Non-trailing or mixed comments - print inside block
        if has_braces {
            self.word("{");
        }
        let mut offset = 0;
        if let BlockFormat::NoBraces(Some(off)) = block_format {
            offset = off;
        }
        self.print_comments(
            pos_hi,
            self.cmnt_config().offset(offset).mixed_no_break().mixed_prev_space().mixed_post_nbsp(),
        );
        self.print_comments(
            pos_hi,
            CommentConfig::default().mixed_no_break().mixed_prev_space().mixed_post_nbsp(),
        );
        if has_braces {
            self.word("}");
        }
    }
}

/// Formatting style for comma-separated lists.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct ListFormat {
    /// The core formatting strategy.
    kind: ListFormatKind,
    /// If `true`, it means that the list already carries indentation.
    no_ind: bool,
    /// If `true`, a single-element list may break.
    break_single: bool,
    /// If `true`, a comment within the list forces a break.
    breaks_cmnts: bool,
    /// If `true`, a space is added after the opening delimiter and before the closing one.
    with_space: bool,
    /// If `true`, the list is enclosed in delimiters.
    with_delimiters: bool,
}

/// The kind of formatting style for a list.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum ListFormatKind {
    /// Always breaks for multiple elements.
    AlwaysBreak,
    /// Breaks all elements if any break.
    Consistent,
    /// Attempts to fit all elements in one line, before breaking consistently.
    Compact,
    /// The list is printed inline, without breaks.
    Inline,
    /// Special formatting for Yul return values.
    Yul { sym_prev: Option<&'static str>, sym_post: Option<&'static str> },
}

impl Default for ListFormat {
    fn default() -> Self {
        Self {
            kind: ListFormatKind::Consistent,
            no_ind: false,
            break_single: false,
            breaks_cmnts: false,
            with_space: false,
            with_delimiters: true,
        }
    }
}

impl ListFormat {
    // -- GETTER METHODS -------------------------------------------------------
    pub(crate) fn prev_symbol(&self) -> Option<&'static str> {
        if let ListFormatKind::Yul { sym_prev, .. } = self.kind { sym_prev } else { None }
    }

    pub(crate) fn post_symbol(&self) -> Option<&'static str> {
        if let ListFormatKind::Yul { sym_post, .. } = self.kind { sym_post } else { None }
    }

    pub(crate) fn is_consistent(&self) -> bool {
        matches!(self.kind, ListFormatKind::Consistent)
    }

    pub(crate) fn is_compact(&self) -> bool {
        matches!(self.kind, ListFormatKind::Compact)
    }

    pub(crate) fn is_inline(&self) -> bool {
        matches!(self.kind, ListFormatKind::Inline)
    }

    pub(crate) fn breaks_with_comments(&self) -> bool {
        self.breaks_cmnts
    }

    // -- BUILDER METHODS ------------------------------------------------------
    pub(crate) fn inline() -> Self {
        Self { kind: ListFormatKind::Inline, ..Default::default() }
    }

    pub(crate) fn consistent() -> Self {
        Self { kind: ListFormatKind::Consistent, ..Default::default() }
    }

    pub(crate) fn compact() -> Self {
        Self { kind: ListFormatKind::Compact, ..Default::default() }
    }

    pub(crate) fn always_break() -> Self {
        Self {
            kind: ListFormatKind::AlwaysBreak,
            breaks_cmnts: true,
            break_single: true,
            with_delimiters: true,
            ..Default::default()
        }
    }

    pub(crate) fn yul(sym_prev: Option<&'static str>, sym_post: Option<&'static str>) -> Self {
        Self {
            kind: ListFormatKind::Yul { sym_prev, sym_post },
            breaks_cmnts: true,
            with_delimiters: true,
            ..Default::default()
        }
    }

    pub(crate) fn without_ind(mut self, without: bool) -> Self {
        if !matches!(self.kind, ListFormatKind::Inline) {
            self.no_ind = without;
        }
        self
    }

    pub(crate) fn break_single(mut self, value: bool) -> Self {
        if !matches!(self.kind, ListFormatKind::Inline) {
            self.break_single = value;
        }
        self
    }

    pub(crate) fn break_cmnts(mut self) -> Self {
        if !matches!(self.kind, ListFormatKind::Inline) {
            self.breaks_cmnts = true;
        }
        self
    }

    pub(crate) fn with_space(mut self) -> Self {
        if !matches!(self.kind, ListFormatKind::Inline) {
            self.with_space = true;
        }
        self
    }

    pub(crate) fn with_delimiters(mut self, with: bool) -> Self {
        if matches!(self.kind, ListFormatKind::Compact | ListFormatKind::Consistent) {
            self.with_delimiters = with;
        }
        self
    }

    // -- PRINTER METHODS ------------------------------------------------------
    pub(crate) fn print_break(&self, soft: bool, elems: usize, p: &mut Printer) {
        match self.kind {
            ListFormatKind::Inline => p.nbsp(), // CAREFUL: we can't use `pp.offset()` afterwards
            ListFormatKind::AlwaysBreak if elems > 1 || (self.break_single && elems == 1) => {
                p.hardbreak()
            }
            _ => {
                if soft && !self.with_space {
                    p.zerobreak();
                } else {
                    p.space();
                }
            }
        }
    }
}

/// Formatting style for code blocks
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[expect(dead_code)]
pub(crate) enum BlockFormat {
    Regular,
    /// Attempts to fit all elements in one line, before breaking consistently. Flags whether to
    /// use braces or not.
    Compact(bool),
    /// Doesn't print braces. Flags the offset that should be applied before opening the block box.
    /// Useful when the caller needs to manually handle the braces.
    NoBraces(Option<isize>),
}

impl BlockFormat {
    pub(crate) fn with_braces(&self) -> bool {
        !matches!(self, Self::NoBraces(_))
    }
    pub(crate) fn breaks(&self) -> bool {
        matches!(self, Self::NoBraces(None))
    }

    pub(crate) fn attempt_single_line(&self) -> bool {
        matches!(self, Self::Compact(_))
    }
}