tachyonfx 0.25.0

A ratatui library for creating shader-like effects in TUIs.
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
use ratatui_core::{
    layout::{Layout, Rect},
    style::Style,
};

use crate::{
    dsl::{environment::DslEnv, expressions::FnCallInfo, Arguments, DslError, EffectDsl},
    fx::IntoTemporaryEffect,
    pattern::{
        AnyPattern, CheckerboardPattern, CoalescePattern, CombinedPattern, DiagonalPattern,
        DiamondPattern, DissolvePattern, InvertedPattern, RadialPattern, SpiralPattern,
        SweepPattern, WavePattern,
    },
    wave::{Modulator, Oscillator, WaveLayer},
    CellFilter, Effect,
};

/// A trait for types that support method chaining in the tachyonfx DSL.
///
/// This trait enables types to handle method chains in DSL expressions by providing
/// a mechanism to fold a sequence of function calls into a final result. It's primarily
/// used for applying sequential modifications to objects like Effects, Layouts, and
/// Styles.
///
/// # Implementation Notes
///
/// Implementors only need to provide the `apply_fn` method, which handles individual
/// function applications. The default `fold_fns` implementation will handle iterating
/// over multiple chained methods.
/// ```
pub(super) trait ChainableMethods
where
    Self: Sized,
{
    fn fold_fns<'dsl>(
        self,
        self_fns: Vec<FnCallInfo>,
        context: &'dsl EffectDsl,
        vars: &'dsl DslEnv,
    ) -> Result<Self, DslError> {
        self_fns.into_iter().try_fold(self, |this, f| {
            let name = f.name;
            let mut args = Arguments::new(f.args.into(), context, vars, f.span);
            let result = Self::apply_fn(this, name.as_str(), &mut args);
            if args.remaining_arg_count() > 0 {
                Err(DslError::TooManyArguments {
                    name,
                    count: args.remaining_arg_count(),
                    location: args.span(),
                })
            } else {
                result
            }
        })
    }

    fn apply_fn(object: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError>;
}

impl ChainableMethods for CellFilter {
    fn apply_fn(filter: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => filter,
            "negated" => filter.negated(),
            "into_static" => filter.into_static(),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Effect {
    fn apply_fn(effect: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => effect,
            "reversed" => effect.reversed(),
            "with_area" => effect.with_area(args.rect()?),
            "with_color_space" => effect.with_color_space(args.color_space()?),
            "with_duration" => effect.with_duration(args.duration()?),
            "with_filter" | "filter" => effect.with_filter(args.cell_filter()?),
            "with_pattern" => effect.with_pattern(args.pattern()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Layout {
    fn apply_fn(layout: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => layout,
            "direction" => layout.direction(args.direction()?),
            "flex" => layout.flex(args.flex()?),
            "constraints" => layout.constraints(args.array(Arguments::constraint)?),
            "margin" => layout.margin(args.read_u16()?),
            "horizontal_margin" => layout.horizontal_margin(args.read_u16()?),
            "vertical_margin" => layout.vertical_margin(args.read_u16()?),
            "spacing" => layout.spacing(args.read_u16()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Style {
    fn apply_fn(style: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => style,
            "fg" => style.fg(args.color()?),
            "bg" => style.bg(args.color()?),
            "add_modifier" => style.add_modifier(args.modifier()?),
            "remove_modifier" => style.remove_modifier(args.modifier()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Rect {
    fn apply_fn(rect: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => rect,
            "clamp" => rect.clamp(args.rect()?),
            "inner" => rect.inner(args.margin()?),
            "intersection" => rect.intersection(args.rect()?),
            "union" => rect.union(args.rect()?),
            "offset" => rect.offset(args.offset()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for CheckerboardPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for DiagonalPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for RadialPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            "with_center" => {
                let center_x = args.read_f32()?;
                let center_y = args.read_f32()?;
                pattern.with_center((center_x, center_y))
            },
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for DiamondPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            "with_center" => {
                let center_x = args.read_f32()?;
                let center_y = args.read_f32()?;
                pattern.with_center((center_x, center_y))
            },
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for SpiralPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            "with_center" => {
                let center_x = args.read_f32()?;
                let center_y = args.read_f32()?;
                pattern.with_center((center_x, center_y))
            },
            "with_arms" => pattern.with_arms(args.read_u16()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for SweepPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for CoalescePattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for DissolvePattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for CombinedPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for InvertedPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for WavePattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => pattern,
            "with_layer" => pattern.with_layer(args.wave_layer()?),
            "with_contrast" => pattern.with_contrast(args.read_i32()?),
            "with_transition_width" => pattern.with_transition_width(args.read_f32()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Modulator {
    fn apply_fn(modulator: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => modulator,
            "phase" => modulator.phase(args.read_f32()?),
            "intensity" => modulator.intensity(args.read_f32()?),
            "on_phase" => modulator.on_phase(),
            "on_amplitude" => modulator.on_amplitude(),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for Oscillator {
    fn apply_fn(osc: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => osc,
            "phase" => osc.phase(args.read_f32()?),
            "modulated_by" => osc.modulated_by(args.modulator()?),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for WaveLayer {
    fn apply_fn(layer: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match name {
            "clone" => layer,
            "multiply" => layer.multiply(args.oscillator()?),
            "average" => layer.average(args.oscillator()?),
            "max" => layer.max(args.oscillator()?),
            "amplitude" => layer.amplitude(args.read_f32()?),
            "power" => layer.power(args.read_i32()?),
            "abs" => layer.abs(),
            _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
        })
    }
}

impl ChainableMethods for AnyPattern {
    fn apply_fn(pattern: Self, name: &str, args: &mut Arguments<'_>) -> Result<Self, DslError> {
        Ok(match pattern {
            AnyPattern::Identity => match name {
                "clone" => pattern,
                _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
            },
            AnyPattern::Radial(inner) => {
                AnyPattern::Radial(RadialPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Diamond(inner) => {
                AnyPattern::Diamond(DiamondPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Diagonal(inner) => {
                AnyPattern::Diagonal(DiagonalPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Checkerboard(inner) => {
                AnyPattern::Checkerboard(CheckerboardPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Sweep(inner) => {
                AnyPattern::Sweep(SweepPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Coalesce(inner) => {
                AnyPattern::Coalesce(CoalescePattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Dissolve(inner) => {
                AnyPattern::Dissolve(DissolvePattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Wave(inner) => AnyPattern::Wave(WavePattern::apply_fn(inner, name, args)?),
            AnyPattern::Spiral(inner) => {
                AnyPattern::Spiral(SpiralPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Combined(inner) => {
                AnyPattern::Combined(CombinedPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Inverted(inner) => {
                AnyPattern::Inverted(InvertedPattern::apply_fn(inner, name, args)?)
            },
            AnyPattern::Blend(_) => match name {
                "clone" => pattern,
                _ => Err(DslError::UnknownFunction { name: name.into(), location: args.span() })?,
            },
        })
    }
}

#[cfg(test)]
mod tests {
    use alloc::collections::VecDeque;

    use super::*;
    use crate::{
        dsl::{
            environment::DslEnv,
            expressions::{Expr, ExprSpan, Value},
            DslFormat, EffectDsl,
        },
        Duration,
    };

    fn create_test_args<'dsl>(
        values: Vec<Value>,
        context: &'dsl EffectDsl,
        vars: &'dsl DslEnv,
    ) -> Arguments<'dsl> {
        let exprs: VecDeque<Expr> = values
            .into_iter()
            .map(|v| Expr::Literal(v, ExprSpan { start: 0, end: 1 }))
            .collect();
        Arguments::new(exprs, context, vars, ExprSpan { start: 0, end: 1 })
    }

    #[test]
    fn test_radial_pattern_method_chaining() {
        let context = EffectDsl::new();
        let vars = DslEnv::new();

        // Test with_transition_width
        let pattern = RadialPattern::center();
        let mut args = create_test_args(vec![Value::F32(3.5)], &context, &vars);
        let result = RadialPattern::apply_fn(pattern, "with_transition_width", &mut args).unwrap();

        // Verify the transition width was set (we can't directly access private fields,
        // but we can test through DSL format)
        assert!(result.dsl_format().contains("3.5"));

        // Test with_center
        let pattern = RadialPattern::center();
        let mut args = create_test_args(vec![Value::F32(0.3), Value::F32(0.7)], &context, &vars);
        let result = RadialPattern::apply_fn(pattern, "with_center", &mut args).unwrap();

        // Verify the center was set
        let formatted = result.dsl_format();
        assert!(formatted.contains("0.3") && formatted.contains("0.7"));

        // Test clone
        let pattern = RadialPattern::center();
        let mut args = create_test_args(vec![], &context, &vars);
        let result = RadialPattern::apply_fn(pattern, "clone", &mut args).unwrap();
        assert_eq!(result.dsl_format(), "RadialPattern::center()");

        // Test unknown method
        let pattern = RadialPattern::center();
        let mut args = create_test_args(vec![], &context, &vars);
        let result = RadialPattern::apply_fn(pattern, "unknown_method", &mut args);
        assert!(result.is_err());
    }

    #[test]
    fn test_any_pattern_method_chaining() {
        let context = EffectDsl::new();
        let vars = DslEnv::new();

        // Test RadialPattern delegation
        let pattern = AnyPattern::Radial(RadialPattern::center());
        let mut args = create_test_args(vec![Value::F32(4.0)], &context, &vars);
        let result = AnyPattern::apply_fn(pattern, "with_transition_width", &mut args).unwrap();

        if let AnyPattern::Radial(radial) = result {
            assert!(radial.dsl_format().contains("4"));
        } else {
            panic!("Expected AnyPattern::Radial");
        }

        // Test Identity clone
        let pattern = AnyPattern::Identity;
        let mut args = create_test_args(vec![], &context, &vars);
        let result = AnyPattern::apply_fn(pattern, "clone", &mut args).unwrap();
        assert!(matches!(result, AnyPattern::Identity));

        // Test Identity unknown method
        let pattern = AnyPattern::Identity;
        let mut args = create_test_args(vec![], &context, &vars);
        let result = AnyPattern::apply_fn(pattern, "unknown_method", &mut args);
        assert!(result.is_err());
    }

    #[test]
    fn test_effect_with_pattern_method_chaining() {
        use crate::fx;

        let context = EffectDsl::new();
        let vars = DslEnv::new();

        // Create a test effect
        let effect = fx::dissolve(Duration::from_millis(1000));

        // Test with_pattern method chaining
        let _radial_pattern =
            AnyPattern::Radial(RadialPattern::center().with_transition_width(3.0));
        let pattern_expr = Expr::FnCall {
            call: crate::dsl::expressions::FnCallInfo {
                name: "RadialPattern::center".into(),
                args: Vec::new(),
                span: ExprSpan { start: 0, end: 1 },
            },
            self_fns: vec![],
        };

        let mut args = create_test_args(vec![], &context, &vars);
        // Manually create an Arguments with a pattern
        let exprs: VecDeque<Expr> = vec![pattern_expr].into();
        let _pattern_args = Arguments::new(exprs, &context, &vars, ExprSpan { start: 0, end: 1 });

        // This would normally work in a real DSL context where any_pattern() can resolve the
        // expression For now, we'll test the method exists and can be called
        let result = Effect::apply_fn(effect, "with_pattern", &mut args);
        // The test will fail because we don't have a proper pattern argument,
        // but it confirms the method exists
        assert!(result.is_err()); // Expected - we need a proper pattern argument

        // Test unknown method still works
        let effect2 = fx::dissolve(Duration::from_millis(500));
        let mut args2 = create_test_args(vec![], &context, &vars);
        let result2 = Effect::apply_fn(effect2, "unknown_method", &mut args2);
        assert!(result2.is_err());
    }
}