1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
use crate::{
comments::{rewrite_with_comments, write_comments},
config::user_def::FieldAlignment,
formatter::{
shape::{ExprKind, LineStyle},
*,
},
utils::{
map::byte_span::{ByteSpan, LeafSpans},
CurlyBrace,
},
};
use std::fmt::Write;
use sway_ast::ItemStruct;
use sway_types::{ast::Delimiter, Spanned};
#[cfg(test)]
mod tests;
impl Format for ItemStruct {
fn format(
&self,
formatted_code: &mut FormattedCode,
formatter: &mut Formatter,
) -> Result<(), FormatterError> {
formatter.with_shape(
formatter
.shape
.with_code_line_from(LineStyle::Multiline, ExprKind::default()),
|formatter| -> Result<(), FormatterError> {
// Required for comment formatting
let start_len = formatted_code.len();
// If there is a visibility token add it to the formatted_code with a ` ` after it.
if let Some(visibility) = &self.visibility {
write!(formatted_code, "{} ", visibility.span().as_str())?;
}
// Add struct token and name
write!(formatted_code, "{} ", self.struct_token.span().as_str())?;
self.name.format(formatted_code, formatter)?;
// Format `GenericParams`, if any
if let Some(generics) = &self.generics {
generics.format(formatted_code, formatter)?;
}
if let Some(where_clause) = &self.where_clause_opt {
writeln!(formatted_code)?;
where_clause.format(formatted_code, formatter)?;
formatter.shape.code_line.update_where_clause(true);
}
let fields = self.fields.get();
// Handle opening brace
Self::open_curly_brace(formatted_code, formatter)?;
if fields.final_value_opt.is_none() && fields.value_separator_pairs.is_empty() {
write_comments(formatted_code, self.span().into(), formatter)?;
}
formatter.shape.code_line.update_expr_new_line(true);
// Determine alignment tactic
match formatter.config.structures.field_alignment {
FieldAlignment::AlignFields(enum_variant_align_threshold) => {
writeln!(formatted_code)?;
let value_pairs = &fields
.value_separator_pairs
.iter()
// TODO: Handle annotations instead of stripping them
.map(|(type_field, comma_token)| (&type_field.value, comma_token))
.collect::<Vec<_>>();
// In first iteration we are going to be collecting the lengths of the struct variants.
// We need to include the `pub` keyword in the length, if the field is public,
// together with one space character between the `pub` and the name.
let variant_length: Vec<usize> = value_pairs
.iter()
.map(|(type_field, _)| {
type_field
.visibility
.as_ref()
// We don't want to hard code the token here to `pub` or just hardcode 4.
// This is in case we introduce e.g. `pub(crate)` one day.
.map_or(0, |token| token.span().as_str().len() + 1)
+ type_field.name.as_str().len()
})
.collect();
// Find the maximum length in the variant_length vector that is still smaller than struct_field_align_threshold.
let mut max_valid_variant_length = 0;
variant_length.iter().for_each(|length| {
if *length > max_valid_variant_length
&& *length < enum_variant_align_threshold
{
max_valid_variant_length = *length;
}
});
let value_pairs_iter = value_pairs.iter().enumerate();
for (var_index, (type_field, comma_token)) in value_pairs_iter.clone() {
write!(formatted_code, "{}", formatter.indent_to_str()?)?;
// If there is a visibility token add it to the formatted_code with a ` ` after it.
if let Some(visibility) = &type_field.visibility {
write!(formatted_code, "{} ", visibility.span().as_str())?;
}
// Add name
type_field.name.format(formatted_code, formatter)?;
let current_variant_length = variant_length[var_index];
if current_variant_length < max_valid_variant_length {
// We need to add alignment between : and ty
// max_valid_variant_length: the length of the variant that we are taking as a reference to align
// current_variant_length: the length of the current variant that we are trying to format
let mut required_alignment =
max_valid_variant_length - current_variant_length;
while required_alignment != 0 {
write!(formatted_code, " ")?;
required_alignment -= 1;
}
}
// Add `:`, ty & `CommaToken`
write!(
formatted_code,
" {} ",
type_field.colon_token.span().as_str(),
)?;
type_field.ty.format(formatted_code, formatter)?;
writeln!(formatted_code, "{}", comma_token.span().as_str())?;
}
if let Some(final_value) = &fields.final_value_opt {
// TODO: Handle annotation
let final_value = &final_value.value;
write!(formatted_code, "{}", final_value.span().as_str())?;
}
}
FieldAlignment::Off => {
fields.format(formatted_code, formatter)?;
}
}
// Handle closing brace
Self::close_curly_brace(formatted_code, formatter)?;
rewrite_with_comments::<ItemStruct>(
formatter,
self.span(),
self.leaf_spans(),
formatted_code,
start_len,
)?;
Ok(())
},
)?;
Ok(())
}
}
impl CurlyBrace for ItemStruct {
fn open_curly_brace(
line: &mut String,
formatter: &mut Formatter,
) -> Result<(), FormatterError> {
formatter.indent();
let open_brace = Delimiter::Brace.as_open_char();
match formatter.shape.code_line.has_where_clause {
true => {
write!(line, "{open_brace}")?;
formatter.shape.code_line.update_where_clause(false);
}
false => {
write!(line, " {open_brace}")?;
}
}
Ok(())
}
fn close_curly_brace(
line: &mut String,
formatter: &mut Formatter,
) -> Result<(), FormatterError> {
// If shape is becoming left-most aligned or - indent just have the default shape
formatter.unindent();
write!(
line,
"{}{}",
formatter.indent_to_str()?,
Delimiter::Brace.as_close_char()
)?;
Ok(())
}
}
impl LeafSpans for ItemStruct {
fn leaf_spans(&self) -> Vec<ByteSpan> {
let mut collected_spans = Vec::new();
if let Some(visibility) = &self.visibility {
collected_spans.push(ByteSpan::from(visibility.span()));
}
collected_spans.push(ByteSpan::from(self.struct_token.span()));
collected_spans.push(ByteSpan::from(self.name.span()));
if let Some(generics) = &self.generics {
collected_spans.push(ByteSpan::from(generics.parameters.span()))
}
collected_spans.append(&mut self.fields.leaf_spans());
collected_spans
}
}