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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
extern crate proc_macro;
use proc_macro::TokenStream;
use proc_macro2::Ident;
use quote::{format_ident, quote, ToTokens, TokenStreamExt};
use std::collections::{HashMap, HashSet};
use std::mem;
use syn::punctuated::Punctuated;
use syn::token::SelfValue;
use syn::{
parse_macro_input, Error, FnArg, GenericArgument, GenericParam, Generics, ImplItem,
ImplItemMethod, ItemImpl, Lifetime, Pat, Path, PathArguments, PathSegment, PredicateType,
ReturnType, Type, TypeParam, TypePath, WhereClause, WherePredicate,
};
macro_rules! bail {
($msg:expr) => {{
return Err($msg.to_string());
}};
}
#[proc_macro_attribute]
pub fn puppet_actor(_attr: TokenStream, item: TokenStream) -> TokenStream {
let info = parse_macro_input!(item as ItemImpl);
generate(info)
}
fn generate(mut info: ItemImpl) -> TokenStream {
let actor_name = if let Type::Path(path) = &*info.self_ty {
get_segment(path).expect("Get struct name").ident
} else {
return Error::new_spanned(info, "Expected macro to be placed on a struct impl.")
.into_compile_error()
.into();
};
let mut actor_generics = info.generics.clone();
let mut actor_where = info.generics.make_where_clause().clone();
if let Err(e) = remove_bounds_from_generics(&mut actor_generics, &mut actor_where) {
return Error::new_spanned(info, e).into_compile_error().into();
}
let mut message_handlers = Vec::new();
for tokens in mem::take(&mut info.items) {
if is_puppet_handler(&tokens) {
if let ImplItem::Method(method) = tokens.clone() {
if method.sig.asyncness.is_none() {
return Error::new_spanned(method, "Message handlers must be async.")
.into_compile_error()
.into();
}
message_handlers.push(method);
}
info.items.push(remove_puppet_handler(tokens));
} else {
info.items.push(tokens);
}
}
let mut generic_builder = create_generic_builder(&actor_generics, &actor_where);
let mut message_callbacks = Vec::new();
for handler in message_handlers {
if !is_ref_self(&handler) {
return Error::new_spanned(
handler,
"Message handler must be either `&self` or `&mut self`",
)
.into_compile_error()
.into();
}
let (msg, types) = match extract_message(&mut generic_builder, &handler) {
Ok(message) => message,
Err(e) => return Error::new_spanned(handler, e).into_compile_error().into(),
};
message_callbacks.push((handler, msg, types));
}
let types = message_callbacks
.iter()
.cloned()
.map(|(_, msg, ty)| {
quote! {
#msg {
msg: #ty,
tx: puppet::__private::futures::channel::oneshot::Sender<<#ty as puppet::Message>::Output>,
}
}
});
let enum_name = format_ident!("{}Op", actor_name);
let enum_traits = message_callbacks
.iter()
.cloned()
.map(|(_handler, msg, ty)| EnumFrom {
name: msg,
message: ty,
parent: enum_name.clone(),
generics: generic_builder.clone(),
});
let enum_variants = message_callbacks.iter().map(|v| v.1.clone());
let enum_caller = message_callbacks.iter().map(|v| v.0.sig.ident.clone());
let remaining_generics = generic_builder.remaining_generics();
let remaining_where = generic_builder.remaining_where();
let enum_where = generic_builder.enum_where();
let enum_tokens = quote! {
pub enum #enum_name #generic_builder
#enum_where
{
#(#types),*
}
impl #generic_builder #enum_name #generic_builder
#enum_where
{
async fn __run #remaining_generics (self, actor: &mut #actor_name #actor_generics)
#remaining_where
{
match self {
#(
Self::#enum_variants { msg, tx } => {
let res = actor.#enum_caller(msg).await;
let _ = tx.send(res);
}
),*
}
}
}
#(#enum_traits)*
};
let tokens = quote! {
#info
impl #actor_generics puppet::Actor for #actor_name #actor_generics #actor_where {
type Messages = #enum_name #generic_builder;
}
impl #actor_generics #actor_name #actor_generics #actor_where {
pub async fn spawn_actor(mut self) -> puppet::ActorMailbox<#actor_name #actor_generics> {
self.spawn_actor_with_queue_size(100).await
}
pub async fn spawn_actor_with_name(mut self, name: impl AsRef<str>) -> puppet::ActorMailbox<#actor_name #actor_generics> {
self.spawn_actor_with_name_and_size(name, 100).await
}
pub async fn spawn_actor_with_queue_size(mut self, n: usize) -> puppet::ActorMailbox<#actor_name #actor_generics> {
self.spawn_actor_with_name_and_size(stringify!(#actor_name), 100).await
}
pub async fn spawn_actor_with_name_and_size(mut self, name: impl AsRef<str>, n: usize) -> puppet::ActorMailbox<#actor_name #actor_generics> {
let (tx, rx) = puppet::__private::flume::bounded::<#enum_name #generic_builder>(n);
puppet::__private::tokio::spawn(async move {
while let Ok(op) = rx.recv_async().await {
op.__run(&mut self).await;
}
});
let name = std::borrow::Cow::Owned(name.as_ref().to_string());
puppet::ActorMailbox::new(tx, name)
}
}
#enum_tokens
};
tokens.into()
}
fn remove_bounds_from_generics(
generics: &mut Generics,
where_clause: &mut WhereClause,
) -> Result<(), String> {
for param in generics.params.iter_mut() {
match param {
GenericParam::Type(ty) => {
let mut segments = Punctuated::new();
segments.push(PathSegment {
ident: ty.ident.clone(),
arguments: PathArguments::None,
});
let mut bounds = Punctuated::new();
for bound in mem::take(&mut ty.bounds) {
bounds.push(bound);
}
let predicate = WherePredicate::Type(PredicateType {
lifetimes: None,
bounded_ty: Type::Path(TypePath {
qself: None,
path: Path {
leading_colon: None,
segments,
},
}),
colon_token: Default::default(),
bounds,
});
where_clause.predicates.push(predicate);
}
GenericParam::Lifetime(_) => {
bail!("Puppet actors cannot support lifetime generics.");
}
GenericParam::Const(_) => {
bail!("Puppet actors cannot support const generics.");
}
}
}
Ok(())
}
struct EnumFrom {
parent: Ident,
name: Ident,
message: Type,
generics: GenericBuilder,
}
impl ToTokens for EnumFrom {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
let parent = self.parent.clone();
let name = self.name.clone();
let message = self.message.clone();
let generics = self.generics.clone();
let where_clause = self.generics.enum_where();
let variant = quote! {
impl #generics puppet::MessageHandler<#message> for #parent #generics
#where_clause
{
fn create(msg: #message) -> (Self, puppet::__private::futures::channel::oneshot::Receiver<<#message as puppet::Message>::Output>) {
let (tx, rx) = puppet::__private::futures::channel::oneshot::channel();
let slf = Self::#name { msg, tx };
(slf, rx)
}
}
};
tokens.append_all(variant);
}
}
fn is_puppet_handler(tokens: &ImplItem) -> bool {
if let ImplItem::Method(ref method) = tokens {
for attr in method.attrs.iter() {
if attr.path.is_ident("puppet") {
return true;
}
}
}
false
}
fn remove_puppet_handler(mut tokens: ImplItem) -> ImplItem {
if let ImplItem::Method(method) = &mut tokens {
method.attrs.retain(|attr| !attr.path.is_ident("puppet"));
}
tokens
}
fn is_ref_self(method: &ImplItemMethod) -> bool {
if let Some(FnArg::Receiver(receiver)) = method.sig.inputs.first() {
if receiver.self_token != SelfValue::default() {
return false;
}
return receiver.reference.is_some();
}
false
}
fn extract_message(
builder: &mut GenericBuilder,
method: &ImplItemMethod,
) -> Result<(Ident, Type), String> {
if method.sig.inputs.len() >= 3 {
bail!(format!(
"Message handler can only support accepting `self` and a single message parameter. Got: {}",
format_inputs(method.sig.inputs.iter().skip(2))
));
}
if let Some(FnArg::Typed(arg)) = method.sig.inputs.iter().nth(1) {
if let Type::Path(path) = &*arg.ty {
let v = check_message_type(builder, path)?;
return Ok((v, *arg.ty.clone()));
} else {
bail!(
"Only concrete types or generics are supported by the system. \
impl trait blocks and others are not."
);
}
}
bail!("Expected message argument to be present.")
}
fn check_message_type(builder: &mut GenericBuilder, path: &TypePath) -> Result<Ident, String> {
let segment = get_segment(path)?;
if let PathArguments::AngleBracketed(arguments) = segment.arguments {
for arg in arguments.args.iter() {
check_valid_generic(builder, arg)?;
}
}
Ok(segment.ident)
}
fn check_valid_generic(
builder: &mut GenericBuilder,
argument: &GenericArgument,
) -> Result<(), String> {
match argument {
GenericArgument::Type(ty) => {
walk_through_generics(builder, ty)?;
}
_ => bail!("Unsupported generics in message handler signature."),
}
Ok(())
}
fn walk_through_generics(builder: &mut GenericBuilder, ty: &Type) -> Result<(), String> {
let types_queue = crossbeam_queue::SegQueue::new();
types_queue.push(ty.clone());
while let Some(ty) = types_queue.pop() {
match ty {
Type::Array(t) => {
types_queue.push(*t.elem);
}
Type::BareFn(t) => {
for lt in t.lifetimes.unwrap_or_default().lifetimes {
check_lifetime_static(Some(<.lifetime))?;
}
for arg in t.inputs {
types_queue.push(arg.ty);
}
match t.output {
ReturnType::Default => {}
ReturnType::Type(_, ty) => {
types_queue.push(*ty);
}
}
}
Type::Group(t) => {
types_queue.push(*t.elem);
}
Type::ImplTrait(_) => bail!("Message handlers do not support impl trait types."),
Type::Infer(_) => bail!("Message handlers do not support inferred types."),
Type::Macro(_) => bail!("Message handlers do not support macros in the arguments."),
Type::Never(_) => {}
Type::Paren(t) => {
types_queue.push(*t.elem);
}
Type::Path(t) => {
for segment in t.path.segments {
builder.check_and_insert_type(&segment.ident);
if let PathArguments::AngleBracketed(generics) = segment.arguments {
for arg in generics.args {
if let GenericArgument::Type(ty) = arg {
types_queue.push(ty);
}
}
}
}
}
Type::Ptr(t) => {
types_queue.push(*t.elem);
}
Type::Reference(t) => {
check_lifetime_static(t.lifetime.as_ref())?;
types_queue.push(*t.elem);
}
Type::Slice(_) => bail!("Slices are not supported by puppet in message handlers."),
Type::TraitObject(_) => {}
Type::Tuple(tuple) => {
for ty in tuple.elems.iter() {
types_queue.push(ty.clone());
}
}
Type::Verbatim(_) => {}
_ => {}
};
}
Ok(())
}
fn check_lifetime_static(lifetime: Option<&Lifetime>) -> Result<(), String> {
if let Some(lt) = lifetime {
if lt.ident != "static" {
bail!("Only `&'static` lifetimes are supported in generic message payloads.")
}
} else {
bail!("Only `&'static` lifetimes are supported in generic message payloads.")
}
Ok(())
}
#[derive(Clone)]
struct GenericBuilder {
types_lookup: HashMap<Ident, TypeParam>,
built_types: HashMap<Ident, TypeParam>,
remaining_generics: HashSet<Ident>,
parent_where: WhereClause,
}
impl GenericBuilder {
fn check_and_insert_type(&mut self, i: &Ident) {
let ty = match self.types_lookup.get(i) {
None => return,
Some(ty) => ty,
};
self.remaining_generics.remove(i);
self.built_types.insert(i.clone(), ty.clone());
}
fn remaining_generics(&self) -> RemainingGenerics {
RemainingGenerics(self.clone())
}
fn remaining_where(&self) -> WhereClause {
let where_ = self.parent_where.clone();
let mut clause = WhereClause {
where_token: Default::default(),
predicates: Punctuated::new(),
};
for pred in where_.predicates.iter() {
if let WherePredicate::Type(ty) = &pred {
if let Type::Path(path) = &ty.bounded_ty {
if let Some(generic) = path.path.segments.first() {
if self.remaining_generics.contains(&generic.ident) {
clause.predicates.push(pred.clone());
}
}
}
}
}
clause
}
fn enum_where(&self) -> WhereClause {
let where_ = self.parent_where.clone();
let mut clause = WhereClause {
where_token: Default::default(),
predicates: Punctuated::new(),
};
for pred in where_.predicates.iter() {
if let WherePredicate::Type(ty) = &pred {
if let Type::Path(path) = &ty.bounded_ty {
if let Some(generic) = path.path.segments.first() {
if self.built_types.contains_key(&generic.ident) {
clause.predicates.push(pred.clone());
}
}
}
}
}
clause
}
}
impl ToTokens for GenericBuilder {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
let generics = self.built_types.keys().cloned();
let stream = quote! {
<#(#generics),*>
};
tokens.append_all(stream);
}
}
struct RemainingGenerics(GenericBuilder);
impl ToTokens for RemainingGenerics {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
let mut generics = Vec::new();
for remaining in self.0.remaining_generics.iter() {
if let Some(ty) = self.0.types_lookup.get(remaining) {
generics.push(ty.clone());
}
}
let stream = quote! {
<#(#generics),*>
};
tokens.append_all(stream);
}
}
fn create_generic_builder(valid_generics: &Generics, where_clause: &WhereClause) -> GenericBuilder {
let mut builder = GenericBuilder {
types_lookup: Default::default(),
built_types: Default::default(),
remaining_generics: Default::default(),
parent_where: where_clause.clone(),
};
for generic in valid_generics.params.iter() {
if let GenericParam::Type(ty) = generic {
builder.remaining_generics.insert(ty.ident.clone());
builder.types_lookup.insert(ty.ident.clone(), ty.clone());
}
}
builder
}
fn get_segment(path: &TypePath) -> Result<PathSegment, String> {
path.path
.segments
.first()
.cloned()
.ok_or_else(|| "Expected message type to be part of function signature.".to_string())
}
fn format_inputs<'a>(inputs: impl Iterator<Item = &'a FnArg>) -> String {
let mut args = Vec::new();
for input in inputs {
if let FnArg::Typed(arg) = &input {
if let Pat::Ident(ident) = &*arg.pat {
args.push(ident.ident.to_string());
}
}
}
args.join(", ")
}
#[cfg(test)]
mod tests {
use syn::{parse_str, ItemImpl};
#[test]
fn test_parse() {
let input = r#"
impl<T: Clone + Bar> Foo<T>
{
}
"#;
let parsed: ItemImpl = parse_str(input).unwrap();
dbg!(parsed);
}
}