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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use super::super::util::*;
use super::{
DataTypeBase, Field, FieldBase, FieldBaseExt, FieldOrOneofExt, FieldRule, FieldType,
LengthDelimitedType, PURORO_INTERNAL, PURORO_LIB,
};
use crate::syn::{
parse2, Arm, Attribute, Expr, ExprMethodCall, FieldValue, ImplItemMethod, PathSegment, Stmt,
Type,
};
use crate::{FatalErrorKind, Result};
use ::once_cell::unsync::OnceCell;
use ::quote::{format_ident, quote};
use ::std::fmt::Debug;
use ::std::rc::Rc;
#[derive(Debug, Clone, Copy)]
struct FieldBitfieldAllocation {
maybe_optional: Option<usize>,
tail: usize,
}
#[derive(Debug, Default)]
struct Cache {
allocated_bitfield: OnceCell<FieldBitfieldAllocation>,
}
impl Field {
pub(crate) fn maybe_allocated_bitfield_tail(&self) -> Result<Option<usize>> {
Ok(self
.cache()
.get::<Cache>()?
.allocated_bitfield
.get()
.map(|a| a.tail))
}
pub(crate) fn assign_and_get_bitfield_tail(&self, head: usize) -> Result<usize> {
let mut alloc = FieldBitfieldAllocation {
maybe_optional: None,
tail: head,
};
match (self.rule()?, self.r#type()?) {
(_, FieldType::LengthDelimited(LengthDelimitedType::Message(_))) => {
}
(FieldRule::Optional, _) => {
alloc.maybe_optional = Some(alloc.tail);
alloc.tail += 1;
}
(FieldRule::Singular | FieldRule::Repeated, _) => {
}
}
match self
.cache()
.get::<Cache>()?
.allocated_bitfield
.try_insert(alloc)
{
Ok(alloc) => Ok(alloc.tail),
Err(_) => Err(FatalErrorKind::InternalError {
detail: "Tried to assign the field's bitfield twice.".to_string(),
})?,
}
}
pub(crate) fn gen_fields_struct_field_type(&self) -> Result<Rc<Type>> {
use FieldRule::*;
use FieldType::*;
use LengthDelimitedType::*;
let primitive_type = self.r#type()?.rust_type()?;
let tag_type = self.r#type()?.tag_type()?;
let bitfield_index = self.bitfield_index_for_optional()?.unwrap_or(usize::MAX);
let type_name_segment: PathSegment = parse2(match (self.rule()?, self.r#type()?) {
(Optional | Singular, LengthDelimited(Message(_))) => quote! {
SingularHeapMessageField::<#primitive_type>
},
(Repeated, LengthDelimited(Message(_))) => quote! {
RepeatedMessageField::<#primitive_type>
},
(Optional, Variant(_) | Bits32(_) | Bits64(_)) => quote! {
OptionalNumericalField::<#primitive_type, #tag_type, #bitfield_index>
},
(Singular, Variant(_) | Bits32(_) | Bits64(_)) => quote! {
SingularNumericalField::<#primitive_type, #tag_type>
},
(Repeated, Variant(_) | Bits32(_) | Bits64(_)) => quote! {
RepeatedNumericalField::<#primitive_type, #tag_type>
},
(Optional, LengthDelimited(_)) => quote! {
OptionalUnsizedField::<#primitive_type, #tag_type, #bitfield_index>
},
(Singular, LengthDelimited(_)) => quote! {
SingularUnsizedField::<#primitive_type, #tag_type>
},
(Repeated, LengthDelimited(_)) => quote! {
RepeatedUnsizedField::<#primitive_type, #tag_type>
},
})?;
Ok(Rc::new(parse2(quote! {
#PURORO_INTERNAL::#type_name_segment
})?))
}
pub(crate) fn gen_message_struct_methods(&self) -> Result<Vec<ImplItemMethod>> {
match self.rule()? {
FieldRule::Repeated => self.gen_message_struct_field_methods_for_repeated(),
_ => self.gen_message_struct_field_methods_for_non_repeated(),
}
}
pub(crate) fn gen_view_struct_methods(&self) -> Result<Vec<ImplItemMethod>> {
match self.rule()? {
FieldRule::Repeated => self.gen_view_struct_field_methods_for_repeated(),
_ => self.gen_view_struct_field_methods_for_non_repeated(),
}
}
pub(crate) fn gen_message_struct_impl_clone_field_value(&self) -> Result<FieldValue> {
let ident = self.gen_fields_struct_field_ident()?;
Ok(parse2(quote! {
#ident: ::std::clone::Clone::clone(&self.fields.#ident)
})?)
}
pub(crate) fn gen_message_struct_impl_message_deser_arm(
&self,
field_data_expr: &Expr,
) -> Result<Arm> {
let ident = self.gen_fields_struct_field_ident()?;
let number = self.number()?;
Ok(parse2(quote! {
#number => #PURORO_INTERNAL::FieldType::deser_from_field_data(
&mut self.view.fields.#ident,
self.view.shared.bitfield_mut(),
#field_data_expr,
)?,
})?)
}
pub(crate) fn gen_message_struct_impl_message_ser_stmt(&self, out_expr: &Expr) -> Result<Stmt> {
let ident = self.gen_fields_struct_field_ident()?;
let number = self.number()?;
Ok(parse2(quote! {
#PURORO_INTERNAL::FieldType::ser_to_write(
&self.view.fields.#ident,
self.view.shared.bitfield(),
#number,
#out_expr,
)?;
})?)
}
pub(crate) fn gen_view_struct_impl_debug_method_call(&self, receiver: &mut Expr) -> Result<()> {
let ident = self.gen_fields_struct_field_ident()?;
let new_expr: ExprMethodCall = parse2(match self.rule()? {
FieldRule::Repeated => {
let getter_ident = format_ident!(
"{}",
self.name()?.to_lower_snake_case().escape_rust_keywords()
);
quote! {
#receiver.field(
stringify!(#ident),
&self.#getter_ident().into_iter().collect::<::std::vec::Vec<_>>().as_slice()
)
}
}
_ => {
let getter_opt_ident = format_ident!("{}_opt", self.name()?.to_lower_snake_case());
quote! {
#receiver.field(stringify!(#ident), &self.#getter_opt_ident())
}
}
})?;
*receiver = new_expr.into();
Ok(())
}
pub(crate) fn gen_view_struct_impl_partial_eq_cmp(&self, rhs_expr: &Expr) -> Result<Expr> {
Ok(parse2(match self.rule()? {
FieldRule::Repeated => {
let getter_ident = format_ident!(
"{}",
self.name()?.to_lower_snake_case().escape_rust_keywords()
);
quote! { self.#getter_ident().into_iter().eq(#rhs_expr.#getter_ident()) }
}
_ => {
let getter_opt_ident = format_ident!("{}_opt", self.name()?.to_lower_snake_case());
quote! { self.#getter_opt_ident() == #rhs_expr.#getter_opt_ident() }
}
})?)
}
fn bitfield_index_for_optional(&self) -> Result<Option<usize>> {
let alloc = if let Some(alloc) = self.cache().get::<Cache>()?.allocated_bitfield.get() {
alloc
} else {
let _ = self.message()?.bitfield_size()?;
let Some(alloc) = self
.cache()
.get::<Cache>()?.allocated_bitfield.get() else {
Err(FatalErrorKind::InternalError { detail: "field bitfield is not set after the message's bitfield size is calculated.".to_string() })?
};
alloc
};
Ok(alloc.maybe_optional)
}
fn gen_message_struct_field_methods_for_repeated(&self) -> Result<Vec<ImplItemMethod>> {
debug_assert!(matches!(self.rule(), Ok(FieldRule::Repeated)));
let getter_mut_ident = format_ident!("{}_mut", self.name()?.to_lower_snake_case());
let clear_ident = format_ident!("clear_{}", self.name()?.to_lower_snake_case());
let field_ident = self.gen_fields_struct_field_ident()?;
let mut_item_type = self.r#type()?.rust_type()?;
Ok(vec![
parse2(quote! {
pub fn #getter_mut_ident(&mut self) -> &mut ::std::vec::Vec::<#mut_item_type> {
use #PURORO_INTERNAL::{RepeatedFieldType, SharedItems as _};
RepeatedFieldType::get_field_mut(
&mut self.view.fields.#field_ident, self.view.shared.bitfield_mut(),
)
}
})?,
parse2(quote! {
pub fn #clear_ident(&mut self) {
use #PURORO_INTERNAL::{RepeatedFieldType, SharedItems as _};
RepeatedFieldType::clear(
&mut self.view.fields.#field_ident, self.view.shared.bitfield_mut(),
)
}
})?,
])
}
fn gen_message_struct_field_methods_for_non_repeated(&self) -> Result<Vec<ImplItemMethod>> {
debug_assert!(matches!(
self.rule(),
Ok(FieldRule::Optional | FieldRule::Singular)
));
let getter_mut_ident = format_ident!("{}_mut", self.name()?.to_lower_snake_case());
let clear_ident = format_ident!("clear_{}", self.name()?.to_lower_snake_case());
let field_ident = self.gen_fields_struct_field_ident()?;
let getter_mut_type = self.r#type()?.rust_mut_ref_type()?;
let default_fn = self.gen_default_fn()?;
Ok(vec![
parse2(quote! {
pub fn #getter_mut_ident(&mut self) -> #getter_mut_type {
use #PURORO_INTERNAL::{NonRepeatedFieldType, SharedItems as _};
NonRepeatedFieldType::get_field_mut(
&mut self.view.fields.#field_ident, self.view.shared.bitfield_mut(), #default_fn,
)
}
})?,
parse2(quote! {
pub fn #clear_ident(&mut self) {
use #PURORO_INTERNAL::{NonRepeatedFieldType, SharedItems as _};
NonRepeatedFieldType::clear(
&mut self.view.fields.#field_ident, self.view.shared.bitfield_mut(),
)
}
})?,
])
}
fn gen_message_struct_field_method_doc_attrs(&self) -> Result<Vec<Attribute>> {
let input_file = self.message()?.input_file()?;
let Some(sci) = input_file.source_code_info(self.location_path()?)? else {
return Ok(Vec::new());
};
Ok(sci.gen_doc_attributes()?)
}
fn gen_view_struct_field_methods_for_repeated(&self) -> Result<Vec<ImplItemMethod>> {
debug_assert!(matches!(self.rule(), Ok(FieldRule::Repeated)));
let getter_ident = format_ident!(
"{}",
self.name()?.to_lower_snake_case().escape_rust_keywords()
);
let field_ident = self.gen_fields_struct_field_ident()?;
let output_type = match self.r#type()? {
FieldType::LengthDelimited(ld_type) => match ld_type {
LengthDelimitedType::String => Rc::new(parse2(quote! { str })?),
LengthDelimitedType::Bytes => Rc::new(parse2(quote! { [u8] })?),
LengthDelimitedType::Message(m) => m.try_upgrade()?.gen_view_struct_type()?,
},
_ => self.r#type()?.rust_type()?,
};
let docs = self.gen_message_struct_field_method_doc_attrs()?;
Ok(vec![parse2(quote! {
#(#docs)*
pub fn #getter_ident(&self) -> impl
'_ + #PURORO_LIB::repeated::RepeatedFieldView<'_, Item = #output_type>
{
use #PURORO_INTERNAL::{RepeatedFieldType, SharedItems as _};
RepeatedFieldType::get_field2(
&self.fields.#field_ident, self.shared.bitfield(),
)
}
})?])
}
fn gen_view_struct_field_methods_for_non_repeated(&self) -> Result<Vec<ImplItemMethod>> {
debug_assert!(matches!(
self.rule(),
Ok(FieldRule::Optional | FieldRule::Singular)
));
let getter_ident = format_ident!(
"{}",
self.name()?.to_lower_snake_case().escape_rust_keywords()
);
let getter_opt_ident = format_ident!("{}_opt", self.name()?.to_lower_snake_case());
let getter_has_ident = format_ident!("has_{}", self.name()?.to_lower_snake_case());
let field_ident = self.gen_fields_struct_field_ident()?;
let borrowed_type = self.r#type()?.rust_maybe_borrowed_type(None)?;
let getter_type = match self.r#type()? {
FieldType::LengthDelimited(LengthDelimitedType::Message(_)) => {
Rc::new(parse2(quote! {
::std::option::Option::< #borrowed_type >
})?)
}
_ => Rc::clone(&borrowed_type),
};
let getter_opt_type = Rc::new(quote! {
::std::option::Option::< #borrowed_type >
});
let default_fn = self.gen_default_fn()?;
let docs = self.gen_message_struct_field_method_doc_attrs()?;
let (getter_docs, getter_opt_docs) = if matches!(self.rule()?, FieldRule::Optional) {
(Vec::new(), docs)
} else {
(docs, Vec::new())
};
Ok(vec![
parse2(quote! {
#(#getter_docs)*
pub fn #getter_ident(&self) -> #getter_type {
use #PURORO_INTERNAL::{NonRepeatedFieldType, SharedItems as _};
NonRepeatedFieldType::get_field_or_else(
&self.fields.#field_ident, self.shared.bitfield(), #default_fn,
)
}
})?,
parse2(quote! {
#(#getter_opt_docs)*
pub fn #getter_opt_ident(&self) -> #getter_opt_type {
use #PURORO_INTERNAL::{NonRepeatedFieldType, SharedItems as _};
NonRepeatedFieldType::get_field_opt(
&self.fields.#field_ident, self.shared.bitfield(),
)
}
})?,
parse2(quote! {
pub fn #getter_has_ident(&self) -> bool {
use #PURORO_INTERNAL::{NonRepeatedFieldType, SharedItems as _};
NonRepeatedFieldType::get_field_opt(
&self.fields.#field_ident, self.shared.bitfield(),
).is_some()
}
})?,
])
}
}