reflow_actor_macro 0.2.1

Procedural macros for declaring Reflow actors.
Documentation
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
use proc_macro::TokenStream;
use quote::{format_ident, quote};
use syn::punctuated::Punctuated;
use syn::{
    Expr, ItemFn, LitBool, LitInt, LitStr, Token, parse::Parse, parse::ParseStream,
    parse_macro_input,
};

/// Delivery semantics for a port connection.
#[derive(Debug, Clone, PartialEq, Default)]
enum PortDelivery {
    /// Block if channel full. Messages never dropped. (default)
    #[default]
    Reliable,
    /// try_send — drop if channel full. For ticks, signals.
    Latest,
    /// Write to shared FramePool, send slot index. For large binary data.
    Pool(String),
}

#[derive(Debug, Clone)]
struct PortDef {
    name: String,
    delivery: PortDelivery,
}

#[derive(Debug, Default)]
struct PortsDefinition {
    capacity: Option<usize>,
    ports: Vec<String>,
    port_defs: Vec<PortDef>,
}

/// Parse a single port entry: `name` or `name: latest` or `name: pool("pool_name")`
fn parse_port_entry(input: ParseStream) -> syn::Result<PortDef> {
    let name = input.parse::<syn::Ident>()?.to_string();

    // Check for `: delivery` annotation
    let delivery = if input.peek(Token![:]) && !input.peek2(Token![:]) {
        input.parse::<Token![:]>()?;
        let kind = input.parse::<syn::Ident>()?;
        match kind.to_string().as_str() {
            "latest" => PortDelivery::Latest,
            "reliable" => PortDelivery::Reliable,
            "pool" => {
                // Parse pool("name")
                let content;
                syn::parenthesized!(content in input);
                let pool_name = content.parse::<syn::LitStr>()?;
                PortDelivery::Pool(pool_name.value())
            }
            other => {
                return Err(syn::Error::new(
                    kind.span(),
                    format!(
                        "Unknown port delivery kind '{}'. Expected 'latest', 'reliable', or 'pool(\"name\")'",
                        other
                    ),
                ));
            }
        }
    } else {
        PortDelivery::Reliable
    };

    Ok(PortDef { name, delivery })
}

impl Parse for PortsDefinition {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        // Parse the capacity in angle brackets, default to 0 if not provided
        let mut capacity = None;
        if input.peek(syn::token::Colon) {
            input.parse::<syn::token::Colon>()?;
            input.parse::<syn::token::Colon>()?;

            let _lt = input.parse::<Token![<]>()?;
            capacity = Some(input.parse::<LitInt>()?.base10_parse()?);
            let _gt = input.parse::<Token![>]>()?;
        }

        // Parse port entries in parentheses
        let content;
        syn::parenthesized!(content in input);

        let mut port_defs = Vec::new();
        while !content.is_empty() {
            port_defs.push(parse_port_entry(&content)?);
            if !content.is_empty() {
                content.parse::<Token![,]>()?;
            }
        }

        let ports = port_defs.iter().map(|p| p.name.clone()).collect();

        Ok(PortsDefinition {
            capacity,
            ports,
            port_defs,
        })
    }
}

struct ActorArgs {
    name: Option<syn::Ident>,
    _state: Option<syn::Ident>,
    inports: PortsDefinition,
    outports: PortsDefinition,
    await_all_inports: bool,
    await_inports: Vec<String>,
}

impl Parse for ActorArgs {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let mut name = None;
        let mut inports = PortsDefinition::default();
        let mut outports = PortsDefinition::default();
        let mut _state = None;
        let mut await_all_inports = false;
        let mut await_inports: Vec<String> = Vec::new();

        // Parse optional struct name
        if !input.peek(syn::token::Paren) {
            name = Some(input.parse::<syn::Ident>()?);
            if !input.is_empty() {
                input.parse::<Token![,]>()?;
            }
        }

        // Parse inports and outports
        while !input.is_empty() {
            let ident = input.parse::<syn::Ident>()?;

            match ident.to_string().as_str() {
                "state" => {
                    let content;
                    syn::parenthesized!(content in input);
                    let state_ident = content.parse::<syn::Ident>()?;
                    _state = Some(state_ident);
                }
                "inports" => {
                    let port_def = input.parse::<PortsDefinition>()?;
                    inports = port_def;
                }
                "outports" => {
                    let port_def = input.parse::<PortsDefinition>()?;
                    outports = port_def;
                }
                "await_all_inports" => {
                    await_all_inports = true;
                }
                "await_inports" => {
                    // Parse: await_inports(port1, port2, port3)
                    let content;
                    syn::parenthesized!(content in input);
                    let ports = Punctuated::<syn::Ident, Token![,]>::parse_terminated(&content)?;
                    await_inports = ports.into_iter().map(|i| i.to_string()).collect();
                }
                _ => {
                    return Err(syn::Error::new(
                        ident.span(),
                        "Expected 'inports', 'outports', 'await_all_inports', or 'await_inports'",
                    ));
                }
            }

            if !input.is_empty() {
                input.parse::<Token![,]>()?;
            }
        }

        Ok(ActorArgs {
            name,
            _state,
            inports,
            outports,
            await_all_inports,
            await_inports,
        })
    }
}

#[derive(Debug, Clone)]
struct DisplayPort {
    name: String,
    data_type: String,
}

#[derive(Debug, Default)]
struct DisplayPortList {
    ports: Vec<DisplayPort>,
}

impl Parse for DisplayPortList {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let content;
        syn::parenthesized!(content in input);
        let mut ports = Vec::new();

        while !content.is_empty() {
            let name = content.parse::<syn::Ident>()?.to_string();
            content.parse::<Token![=]>()?;
            let data_type = content.parse::<LitStr>()?.value();
            ports.push(DisplayPort { name, data_type });
            if !content.is_empty() {
                content.parse::<Token![,]>()?;
            }
        }

        Ok(Self { ports })
    }
}

#[derive(Default)]
struct DisplayComponentArgs {
    element: Option<String>,
    bundle_id: Option<String>,
    source: Option<Expr>,
    shadow: Option<bool>,
    observed_props: Vec<String>,
    width: Option<String>,
}

impl Parse for DisplayComponentArgs {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let content;
        syn::parenthesized!(content in input);
        let mut display = Self::default();

        while !content.is_empty() {
            let key = content.parse::<syn::Ident>()?;
            match key.to_string().as_str() {
                "element" => {
                    content.parse::<Token![=]>()?;
                    display.element = Some(content.parse::<LitStr>()?.value());
                }
                "bundle_id" => {
                    content.parse::<Token![=]>()?;
                    display.bundle_id = Some(content.parse::<LitStr>()?.value());
                }
                "source" => {
                    content.parse::<Token![=]>()?;
                    display.source = Some(content.parse::<Expr>()?);
                }
                "shadow" => {
                    content.parse::<Token![=]>()?;
                    display.shadow = Some(content.parse::<LitBool>()?.value);
                }
                "observed_props" => {
                    let props;
                    syn::parenthesized!(props in content);
                    let parsed = Punctuated::<LitStr, Token![,]>::parse_terminated(&props)?;
                    display.observed_props = parsed.into_iter().map(|prop| prop.value()).collect();
                }
                "width" => {
                    content.parse::<Token![=]>()?;
                    display.width = Some(content.parse::<LitStr>()?.value());
                }
                other => {
                    return Err(syn::Error::new(
                        key.span(),
                        format!(
                            "Unknown display key '{}'. Expected element, bundle_id, source, shadow, observed_props, or width",
                            other
                        ),
                    ));
                }
            }

            if !content.is_empty() {
                content.parse::<Token![,]>()?;
            }
        }

        Ok(display)
    }
}

struct ActorDisplayArgs {
    actor: Option<syn::Ident>,
    id: String,
    title: String,
    subtitle: Option<String>,
    category: String,
    subcategory: Option<String>,
    description: String,
    icon: String,
    variant: Option<String>,
    inputs: DisplayPortList,
    outputs: DisplayPortList,
    display: Option<DisplayComponentArgs>,
}

impl Default for ActorDisplayArgs {
    fn default() -> Self {
        Self {
            actor: None,
            id: String::new(),
            title: String::new(),
            subtitle: None,
            category: "reflow".to_string(),
            subcategory: None,
            description: String::new(),
            icon: "cpu".to_string(),
            variant: None,
            inputs: DisplayPortList::default(),
            outputs: DisplayPortList::default(),
            display: None,
        }
    }
}

impl Parse for ActorDisplayArgs {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let mut args = Self::default();

        while !input.is_empty() {
            let key = input.parse::<syn::Ident>()?;
            match key.to_string().as_str() {
                "actor" => {
                    input.parse::<Token![=]>()?;
                    args.actor = Some(input.parse::<syn::Ident>()?);
                }
                "id" | "template_id" => {
                    input.parse::<Token![=]>()?;
                    args.id = input.parse::<LitStr>()?.value();
                }
                "title" => {
                    input.parse::<Token![=]>()?;
                    args.title = input.parse::<LitStr>()?.value();
                }
                "subtitle" => {
                    input.parse::<Token![=]>()?;
                    args.subtitle = Some(input.parse::<LitStr>()?.value());
                }
                "category" => {
                    input.parse::<Token![=]>()?;
                    args.category = input.parse::<LitStr>()?.value();
                }
                "subcategory" => {
                    input.parse::<Token![=]>()?;
                    args.subcategory = Some(input.parse::<LitStr>()?.value());
                }
                "description" => {
                    input.parse::<Token![=]>()?;
                    args.description = input.parse::<LitStr>()?.value();
                }
                "icon" => {
                    input.parse::<Token![=]>()?;
                    args.icon = input.parse::<LitStr>()?.value();
                }
                "variant" => {
                    input.parse::<Token![=]>()?;
                    args.variant = Some(input.parse::<LitStr>()?.value());
                }
                "inputs" => {
                    args.inputs = input.parse::<DisplayPortList>()?;
                }
                "outputs" => {
                    args.outputs = input.parse::<DisplayPortList>()?;
                }
                "display" => {
                    args.display = Some(input.parse::<DisplayComponentArgs>()?);
                }
                other => {
                    return Err(syn::Error::new(
                        key.span(),
                        format!(
                            "Unknown actor_display key '{}'. Expected actor, id, title, subtitle, category, subcategory, description, icon, variant, inputs, outputs, or display",
                            other
                        ),
                    ));
                }
            }

            if !input.is_empty() {
                input.parse::<Token![,]>()?;
            }
        }

        if args.id.is_empty() {
            return Err(input.error("actor_display requires id = \"tpl_...\""));
        }
        if args.title.is_empty() {
            return Err(input.error("actor_display requires title = \"...\""));
        }
        if args.description.is_empty() {
            return Err(input.error("actor_display requires description = \"...\""));
        }

        Ok(args)
    }
}

#[proc_macro_attribute]
pub fn actor(attr: TokenStream, item: TokenStream) -> TokenStream {
    let args = parse_macro_input!(attr as ActorArgs);
    let input_fn = parse_macro_input!(item as ItemFn);
    let fn_name = &input_fn.sig.ident;
    let fn_vis = &input_fn.vis;

    // Create struct name from either provided name or function name
    let struct_name = match args.name {
        Some(name) => name,
        None => format_ident!(
            "{}Actor",
            fn_name
                .to_string()
                .chars()
                .next()
                .unwrap()
                .to_uppercase()
                .to_string()
                + &fn_name.to_string()[1..]
        ),
    };
    // Generate port initialization code
    let init_inports = args.inports.ports.iter().map(|port| {
        let name = port;
        quote! {
            String::from(#name)
        }
    });

    let init_outports = args.outports.ports.iter().map(|port| {
        let name = port;
        quote! {
            String::from(#name)
        }
    });

    let out_ports_cap = args.outports.capacity;
    let _in_ports_cap = args.inports.capacity;
    let await_all_inports = args.await_all_inports;
    let await_inports_list = &args.await_inports;
    let _has_selective_await = !await_inports_list.is_empty();

    let out_ports_channel = if let Some(out_ports_cap) = out_ports_cap {
        if out_ports_cap < 1 {
            panic!("Outports capacity must be greater than 0");
        }
        quote! {flume::bounded(#out_ports_cap)}
    } else {
        quote! {flume::unbounded()}
    };
    // Actor inport channel is always unbounded — per-connector forwarder
    // channels handle backpressure via bounded(64) + delivery semantics.
    // The inport is just a merge point for all connectors, not a throttle.
    let in_ports_channel = quote! {flume::unbounded()};

    // Re-generate port name iterators for trait methods
    let inport_names_iter = args.inports.ports.iter().map(|port| {
        quote! { String::from(#port) }
    });
    let outport_names_iter = args.outports.ports.iter().map(|port| {
        quote! { String::from(#port) }
    });

    // Generate port delivery metadata entries
    let all_port_defs: Vec<&PortDef> = args
        .inports
        .port_defs
        .iter()
        .chain(args.outports.port_defs.iter())
        .collect();
    let port_delivery_entries = all_port_defs.iter().filter_map(|pd| {
        match &pd.delivery {
            PortDelivery::Reliable => None, // default, no entry needed
            PortDelivery::Latest => {
                let name = &pd.name;
                Some(quote! { m.insert(#name.to_string(), "latest".to_string()); })
            }
            PortDelivery::Pool(pool_name) => {
                let name = &pd.name;
                let pool = pool_name.as_str();
                Some(quote! { m.insert(#name.to_string(), format!("pool:{}", #pool)); })
            }
        }
    });

    let expanded = quote! {

        // Keep the original function
        #input_fn

        #fn_vis struct #struct_name {
            inports_channel: Port,
            outports_channel: Port,
        }

        impl #struct_name {
            pub fn new() -> Self {
                Self {
                    // NOTE: channels are intentionally cross-assigned —
                    // inports get the outport-declared capacity and vice
                    // versa.  Fixing this swap requires updating every
                    // actor's capacity declarations first (many use
                    // outports::<1> which would deadlock with bounded(1)).
                    inports_channel: #out_ports_channel,
                    outports_channel: #in_ports_channel,
                }
            }

            /// Get a list of available input ports
            pub fn input_ports(&self) -> Vec<String> {
                vec![#(#init_inports),*]
            }

            /// Get a list of available output ports
            pub fn output_ports(&self) -> Vec<String> {
                vec![#(#init_outports),*]
            }
        }

        impl Clone for #struct_name {
            fn clone(&self) -> Self {
                Self {
                    inports_channel: self.inports_channel.clone(),
                    outports_channel: self.outports_channel.clone(),
                }
            }
        }

        impl Actor for #struct_name {

            fn get_behavior(&self) -> ActorBehavior {
                Box::new(|context: ActorContext| {
                    Box::pin(async move {
                        #fn_name(context).await
                    })
                })
            }

            fn get_outports(&self) -> Port {
                self.outports_channel.clone()
            }

            fn get_inports(&self) -> Port {
                self.inports_channel.clone()
            }

            fn inport_names(&self) -> Vec<String> {
                vec![#(#inport_names_iter),*]
            }

            fn outport_names(&self) -> Vec<String> {
                vec![#(#outport_names_iter),*]
            }

            fn await_all_inports(&self) -> bool {
                #await_all_inports
            }

            fn required_inports(&self) -> Vec<String> {
                vec![#(String::from(#await_inports_list)),*]
            }

            fn port_delivery(&self) -> std::collections::HashMap<String, String> {
                let mut m = std::collections::HashMap::new();
                #(#port_delivery_entries)*
                m
            }

            fn create_instance(&self) -> std::sync::Arc<dyn Actor> {
                std::sync::Arc::new(Self::new())
            }

            // create_process() and create_state() use the trait defaults
            // via ActorProcess. Override only for non-MemoryState state types.
        }
    };

    TokenStream::from(expanded)
}

#[proc_macro_attribute]
pub fn actor_display(attr: TokenStream, item: TokenStream) -> TokenStream {
    let args = parse_macro_input!(attr as ActorDisplayArgs);
    let input_fn = parse_macro_input!(item as ItemFn);
    let fn_name = &input_fn.sig.ident;
    let fn_vis = &input_fn.vis;
    let template_fn = format_ident!("{}_template", fn_name);

    let actor_struct = args.actor.unwrap_or_else(|| {
        format_ident!(
            "{}Actor",
            fn_name
                .to_string()
                .chars()
                .next()
                .unwrap()
                .to_uppercase()
                .to_string()
                + &fn_name.to_string()[1..]
        )
    });

    let id = args.id;
    let title = args.title;
    let subtitle = args.subtitle;
    let category = args.category;
    let subcategory = args.subcategory;
    let description = args.description;
    let icon = args.icon;
    let variant = args.variant;

    let subtitle_tokens = option_string_tokens(subtitle);
    let subcategory_tokens = option_string_tokens(subcategory);
    let variant_tokens = option_string_tokens(variant);

    let input_ports = args.inputs.ports.iter().map(|port| {
        let name = &port.name;
        let label = label_from_port_name(name);
        let data_type = &port.data_type;
        quote! {
            ::reflow_network::template::Port {
                id: #name.to_string(),
                label: #label.to_string(),
                port_type: ::reflow_network::template::PortType::Input,
                position: ::reflow_network::template::PortPosition::Left,
                data_type: Some(#data_type.to_string()),
                required: None,
                multiple: None,
            }
        }
    });

    let output_ports = args.outputs.ports.iter().map(|port| {
        let name = &port.name;
        let label = label_from_port_name(name);
        let data_type = &port.data_type;
        quote! {
            ::reflow_network::template::Port {
                id: #name.to_string(),
                label: #label.to_string(),
                port_type: ::reflow_network::template::PortType::Output,
                position: ::reflow_network::template::PortPosition::Right,
                data_type: Some(#data_type.to_string()),
                required: None,
                multiple: None,
            }
        }
    });

    let ports = input_ports.chain(output_ports).collect::<Vec<_>>();

    let display = match args.display {
        Some(display) => {
            let element = display.element.unwrap_or_default();
            let bundle_id_tokens = option_string_tokens(display.bundle_id);
            let source = display.source;
            let shadow_tokens = match display.shadow {
                Some(value) => quote! { Some(#value) },
                None => quote! { None },
            };
            let observed_props = display.observed_props;
            let width_tokens = option_string_tokens(display.width);

            let source_tokens = match source {
                Some(source) => quote! { Some((#source).to_string()) },
                None => quote! { None },
            };

            quote! {
                Some(::reflow_network::template::DisplayComponent {
                    element: #element.to_string(),
                    bundle_id: #bundle_id_tokens,
                    source: #source_tokens,
                    shadow: #shadow_tokens,
                    observed_props: Some(vec![#(#observed_props.to_string()),*]),
                    width: #width_tokens,
                })
            }
        }
        None => quote! { None },
    };

    let expanded = quote! {
        #input_fn

        #fn_vis fn #template_fn(
            version: &Option<String>,
            capabilities: &Option<Vec<String>>,
        ) -> ::reflow_network::template::NodeTemplate {
            ::reflow_network::template::NodeTemplate {
                id: #id.to_string(),
                type_name: #id.to_string(),
                title: #title.to_string(),
                subtitle: #subtitle_tokens,
                category: #category.to_string(),
                subcategory: #subcategory_tokens,
                description: #description.to_string(),
                icon: #icon.to_string(),
                variant: #variant_tokens,
                shape: Some(::reflow_network::template::NodeShape::Rectangle),
                size: Some(::reflow_network::template::NodeSize::Medium),
                ports: vec![#(#ports),*],
                properties: None,
                property_rules: None,
                runtime: Some(::reflow_network::template::RuntimeRequirements {
                    executor: "reflow".to_string(),
                    version: version.clone(),
                    required_env_vars: None,
                    capabilities: capabilities.clone(),
                }),
                display: #display,
            }
        }

        impl #actor_struct {
            pub fn actor_template(
                version: &Option<String>,
                capabilities: &Option<Vec<String>>,
            ) -> ::reflow_network::template::NodeTemplate {
                #template_fn(version, capabilities)
            }
        }
    };

    TokenStream::from(expanded)
}

fn label_from_port_name(name: &str) -> String {
    name.split('_')
        .map(|part| {
            let mut chars = part.chars();
            match chars.next() {
                Some(first) => first.to_uppercase().collect::<String>() + chars.as_str(),
                None => String::new(),
            }
        })
        .collect::<Vec<_>>()
        .join(" ")
}

fn option_string_tokens(value: Option<String>) -> proc_macro2::TokenStream {
    match value {
        Some(value) => quote! { Some(#value.to_string()) },
        None => quote! { None },
    }
}