Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor visit_struct, visit_enum to propagate RewriteResult #6395

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+57 −51
Open

Refactor visit_struct, visit_enum to propagate RewriteResult #6395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/expr.rs
View file
Original file line number Diff line number Diff line change
@@ -1671,8 +1671,7 @@ fn rewrite_struct_lit<'a>(
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 {
90 changes: 48 additions & 42 deletions src/items.rs
View file
Original file line number Diff line number Diff line change
@@ -527,7 +527,7 @@ impl<'a> FmtVisitor<'a> {
};
let rewrite = format_struct(&self.get_context(), struct_parts, self.block_indent, None)
.map(|s| if is_tuple { s + ";" } else { s });
self.push_rewrite(struct_parts.span, rewrite);
self.push_rewrite(struct_parts.span, rewrite.ok());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After majority of visit_*** functions are refactored, we'll have to report RewriteError instead of calling rewrite.ok()

}

pub(crate) fn visit_enum(
@@ -565,9 +565,10 @@ impl<'a> FmtVisitor<'a> {
self.last_pos = body_start;

match self.format_variant_list(enum_def, body_start, span.hi()) {
Some(ref s) if enum_def.variants.is_empty() => self.push_str(s),
Ok(ref s) if enum_def.variants.is_empty() => self.push_str(s),

rw => {
self.push_rewrite(mk_sp(body_start, span.hi()), rw);
self.push_rewrite(mk_sp(body_start, span.hi()), rw.ok());
self.block_indent = self.block_indent.block_unindent(self.config);
}
}
@@ -579,7 +580,7 @@ impl<'a> FmtVisitor<'a> {
enum_def: &ast::EnumDef,
body_lo: BytePos,
body_hi: BytePos,
) -> Option<String> {
) -> RewriteResult {
if enum_def.variants.is_empty() {
let mut buffer = String::with_capacity(128);
// 1 = "}"
@@ -592,7 +593,7 @@ impl<'a> FmtVisitor<'a> {
"",
"}",
);
return Some(buffer);
return Ok(buffer);
}
let mut result = String::with_capacity(1024);
let original_offset = self.block_indent;
@@ -629,10 +630,7 @@ impl<'a> FmtVisitor<'a> {
}
},
|f| f.span.hi(),
|f| {
self.format_variant(f, one_line_width, pad_discrim_ident_to)
.unknown_error()
},
|f| self.format_variant(f, one_line_width, pad_discrim_ident_to),
body_lo,
body_hi,
false,
@@ -648,16 +646,19 @@ impl<'a> FmtVisitor<'a> {
items = itemize_list_with(0);
}

let shape = self.shape().sub_width(2)?;
let shape = self
.shape()
.sub_width(2)
.max_width_error(self.shape().width, mk_sp(body_lo, body_hi))?;
let fmt = ListFormatting::new(shape, self.config)
.trailing_separator(self.config.trailing_comma())
.preserve_newline(true);

let list = write_list(&items, &fmt).ok()?;
let list = write_list(&items, &fmt)?;
result.push_str(&list);
result.push_str(&original_offset.to_string_with_newline(self.config));
result.push('}');
Some(result)
Ok(result)
}

// Variant of an enum.
@@ -666,23 +667,30 @@ impl<'a> FmtVisitor<'a> {
field: &ast::Variant,
one_line_width: usize,
pad_discrim_ident_to: usize,
) -> Option<String> {
) -> RewriteResult {
if contains_skip(&field.attrs) {
let lo = field.attrs[0].span.lo();
let span = mk_sp(lo, field.span.hi());
return Some(self.snippet(span).to_owned());
return Ok(self.snippet(span).to_owned());
}

let context = self.get_context();
let shape = self.shape();
let attrs_str = if context.config.style_edition() >= StyleEdition::Edition2024 {
field.attrs.rewrite(&context, shape)?
field.attrs.rewrite_result(&context, shape)?
} else {
// StyleEdition::Edition20{15|18|21} formatting that was off by 1. See issue #5801
field.attrs.rewrite(&context, shape.sub_width(1)?)?
field.attrs.rewrite_result(
&context,
shape
.sub_width(1)
.max_width_error(shape.width, field.span)?,
)?
};
// sub_width(1) to take the trailing comma into account
let shape = shape.sub_width(1)?;
let shape = shape
.sub_width(1)
.max_width_error(shape.width, field.span)?;

let lo = field
.attrs
@@ -710,14 +718,12 @@ impl<'a> FmtVisitor<'a> {
shape,
&RhsAssignKind::Expr(&ex.kind, ex.span),
RhsTactics::AllowOverflow,
)
.ok()?
)?
} else {
variant_body
};

combine_strs_with_missing_comments(&context, &attrs_str, &variant_body, span, shape, false)
.ok()
}

fn visit_impl_items(&mut self, items: &[ptr::P<ast::AssocItem>]) {
@@ -1145,7 +1151,7 @@ fn format_struct(
struct_parts: &StructParts<'_>,
offset: Indent,
one_line_width: Option<usize>,
) -> Option<String> {
) -> RewriteResult {
match struct_parts.def {
ast::VariantData::Unit(..) => format_unit_struct(context, struct_parts, offset),
ast::VariantData::Tuple(fields, _) => {
@@ -1410,7 +1416,7 @@ fn format_unit_struct(
context: &RewriteContext<'_>,
p: &StructParts<'_>,
offset: Indent,
) -> Option<String> {
) -> RewriteResult {
let header_str = format_header(context, p.prefix, p.ident, p.vis, offset);
let generics_str = if let Some(generics) = p.generics {
let hi = context.snippet_provider.span_before_last(p.span, ";");
@@ -1427,7 +1433,7 @@ fn format_unit_struct(
} else {
String::new()
};
Some(format!("{header_str}{generics_str};"))
Ok(format!("{header_str}{generics_str};"))
}

pub(crate) fn format_struct_struct(
@@ -1436,7 +1442,7 @@ pub(crate) fn format_struct_struct(
fields: &[ast::FieldDef],
offset: Indent,
one_line_width: Option<usize>,
) -> Option<String> {
) -> RewriteResult {
let mut result = String::with_capacity(1024);
let span = struct_parts.span;

@@ -1496,18 +1502,20 @@ pub(crate) fn format_struct_struct(
if fields.is_empty() {
let inner_span = mk_sp(body_lo, span.hi() - BytePos(1));
format_empty_struct_or_tuple(context, inner_span, offset, &mut result, "", "}");
return Some(result);
return Ok(result);
}

// 3 = ` ` and ` }`
let one_line_budget = context.budget(result.len() + 3 + offset.width());
let one_line_budget =
one_line_width.map_or(0, |one_line_width| min(one_line_width, one_line_budget));

let shape = Shape::indented(offset.block_indent(context.config), context.config);
let shape = shape.sub_width(1).max_width_error(shape.width, span)?;
let items_str = rewrite_with_alignment(
fields,
context,
Shape::indented(offset.block_indent(context.config), context.config).sub_width(1)?,
shape,
mk_sp(body_lo, span.hi()),
one_line_budget,
)?;
@@ -1517,9 +1525,9 @@ pub(crate) fn format_struct_struct(
&& items_str.len() <= one_line_budget
&& !last_line_contains_single_line_comment(&items_str)
{
Some(format!("{result} {items_str} }}"))
Ok(format!("{result} {items_str} }}"))
} else {
Some(format!(
Ok(format!(
"{}\n{}{}\n{}}}",
result,
offset
@@ -1582,7 +1590,7 @@ fn format_tuple_struct(
struct_parts: &StructParts<'_>,
fields: &[ast::FieldDef],
offset: Indent,
) -> Option<String> {
) -> RewriteResult {
let mut result = String::with_capacity(1024);
let span = struct_parts.span;

@@ -1614,7 +1622,7 @@ fn format_tuple_struct(
Some(generics) => {
let budget = context.budget(last_line_width(&header_str));
let shape = Shape::legacy(budget, offset);
let generics_str = rewrite_generics(context, "", generics, shape).ok()?;
let generics_str = rewrite_generics(context, "", generics, shape)?;
result.push_str(&generics_str);

let where_budget = context.budget(last_line_width(&result));
@@ -1630,8 +1638,7 @@ fn format_tuple_struct(
None,
body_hi,
option,
)
.ok()?
)?
}
None => "".to_owned(),
};
@@ -1643,7 +1650,8 @@ fn format_tuple_struct(
let inner_span = mk_sp(body_lo, body_hi);
format_empty_struct_or_tuple(context, inner_span, offset, &mut result, "(", ")");
} else {
let shape = Shape::indented(offset, context.config).sub_width(1)?;
let shape = Shape::indented(offset, context.config);
let shape = shape.sub_width(1).max_width_error(shape.width, span)?;
let lo = if let Some(generics) = struct_parts.generics {
generics.span.hi()
} else {
@@ -1657,8 +1665,7 @@ fn format_tuple_struct(
mk_sp(lo, span.hi()),
context.config.fn_call_width(),
None,
)
.ok()?;
)?;
}

if !where_clause_str.is_empty()
@@ -1676,7 +1683,7 @@ fn format_tuple_struct(
}
result.push_str(&where_clause_str);

Some(result)
Ok(result)
}

pub(crate) enum ItemVisitorKind<'a> {
@@ -3321,9 +3328,9 @@ fn format_generics(
offset: Indent,
span: Span,
used_width: usize,
) -> Option<String> {
) -> RewriteResult {
let shape = Shape::legacy(context.budget(used_width + offset.width()), offset);
let mut result = rewrite_generics(context, "", generics, shape).ok()?;
let mut result = rewrite_generics(context, "", generics, shape)?;

// If the generics are not parameterized then generics.span.hi() == 0,
// so we use span.lo(), which is the position after `struct Foo`.
@@ -3349,8 +3356,7 @@ fn format_generics(
Some(span.hi()),
span_end_before_where,
option,
)
.ok()?;
)?;
result.push_str(&where_clause_str);
(
brace_pos == BracePos::ForceSameLine || brace_style == BraceStyle::PreferSameLine,
@@ -3389,7 +3395,7 @@ fn format_generics(
!is_block
});
if brace_pos == BracePos::None {
return Some(result);
return Ok(result);
}
let total_used_width = last_line_used_width(&result, used_width);
let remaining_budget = context.budget(total_used_width);
@@ -3412,7 +3418,7 @@ fn format_generics(
}
result.push('{');

Some(result)
Ok(result)
}

impl Rewrite for ast::ForeignItem {
15 changes: 8 additions & 7 deletions src/vertical.rs
View file
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ use crate::items::{rewrite_struct_field, rewrite_struct_field_prefix};
use crate::lists::{
ListFormatting, ListItem, Separator, definitive_tactic, itemize_list, write_list,
};
use crate::rewrite::{Rewrite, RewriteContext, RewriteResult};
use crate::rewrite::{Rewrite, RewriteContext, RewriteErrorExt, RewriteResult};
use crate::shape::{Indent, Shape};
use crate::source_map::SpanUtils;
use crate::spanned::Spanned;
@@ -114,7 +114,7 @@ pub(crate) fn rewrite_with_alignment<T: AlignedItem>(
shape: Shape,
span: Span,
one_line_width: usize,
) -> Option<String> {
) -> RewriteResult {
let (spaces, group_index) = if context.config.struct_field_align_threshold() > 0 {
group_aligned_items(context, fields)
} else {
@@ -172,11 +172,11 @@ pub(crate) fn rewrite_with_alignment<T: AlignedItem>(
force_separator,
)?;
if rest.is_empty() {
Some(result + spaces)
Ok(result + spaces)
} else {
let rest_span = mk_sp(init_last_pos, span.hi());
let rest_str = rewrite_with_alignment(rest, context, shape, rest_span, one_line_width)?;
Some(format!(
Ok(format!(
"{}{}\n{}{}",
result,
spaces,
@@ -211,9 +211,10 @@ fn rewrite_aligned_items_inner<T: AlignedItem>(
offset: Indent,
one_line_width: usize,
force_trailing_separator: bool,
) -> Option<String> {
) -> RewriteResult {
// 1 = ","
let item_shape = Shape::indented(offset, context.config).sub_width(1)?;
let shape = Shape::indented(offset, context.config);
let item_shape = shape.sub_width(1).max_width_error(shape.width, span)?;
let (mut field_prefix_max_width, field_prefix_min_width) =
struct_field_prefix_max_min_width(context, fields, item_shape);
let max_diff = field_prefix_max_width.saturating_sub(field_prefix_min_width);
@@ -266,7 +267,7 @@ fn rewrite_aligned_items_inner<T: AlignedItem>(
.tactic(tactic)
.trailing_separator(separator_tactic)
.preserve_newline(true);
write_list(&items, &fmt).ok()
write_list(&items, &fmt)
}

/// Returns the index in `fields` up to which a field belongs to the current group.