dampen-core 0.3.2

Core parser, IR, and traits for Dampen UI framework
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
//! Handler system for event dispatch

use std::any::Any;
use std::collections::{HashMap, HashSet};
use std::sync::{Arc, RwLock};

/// Registry of event handlers
#[derive(Clone, Debug)]
pub struct HandlerRegistry {
    handlers: Arc<RwLock<HashMap<String, HandlerEntry>>>,
}

/// Entry in the handler registry
#[derive(Clone)]
#[allow(clippy::type_complexity)]
pub enum HandlerEntry {
    // ============================================
    // Existing variants (unchanged for compatibility)
    // ============================================
    /// Simple handler: `fn(&mut Model)`
    Simple(Arc<dyn Fn(&mut dyn Any) + Send + Sync>),

    /// Handler with value: `fn(&mut Model, T)`
    WithValue(Arc<dyn Fn(&mut dyn Any, Box<dyn Any>) + Send + Sync>),

    /// Handler returning command: `fn(&mut Model) -> Command<Message>`
    WithCommand(Arc<dyn Fn(&mut dyn Any) -> Box<dyn Any> + Send + Sync>),

    // ============================================
    // New variants for shared state access
    // ============================================
    /// Handler with shared context: `fn(&mut Model, &SharedContext<S>)`
    ///
    /// Use when the handler needs to read or write shared state.
    WithShared(Arc<dyn Fn(&mut dyn Any, &dyn Any) + Send + Sync>),

    /// Handler with value and shared: `fn(&mut Model, T, &SharedContext<S>)`
    ///
    /// Use when the handler receives input value and needs shared state.
    WithValueAndShared(Arc<dyn Fn(&mut dyn Any, Box<dyn Any>, &dyn Any) + Send + Sync>),

    /// Handler with command and shared: `fn(&mut Model, &SharedContext<S>) -> Command`
    ///
    /// Use when the handler needs shared state and returns a command.
    WithCommandAndShared(Arc<dyn Fn(&mut dyn Any, &dyn Any) -> Box<dyn Any> + Send + Sync>),

    /// Handler with canvas event: `fn(&mut Model, CanvasEvent)`
    WithCanvasEvent(Arc<dyn Fn(&mut dyn Any, CanvasEvent) + Send + Sync>),
}

impl std::fmt::Debug for HandlerEntry {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            HandlerEntry::Simple(_) => f.write_str("Simple(handler)"),
            HandlerEntry::WithValue(_) => f.write_str("WithValue(handler)"),
            HandlerEntry::WithCommand(_) => f.write_str("WithCommand(handler)"),
            HandlerEntry::WithShared(_) => f.write_str("WithShared(handler)"),
            HandlerEntry::WithValueAndShared(_) => f.write_str("WithValueAndShared(handler)"),
            HandlerEntry::WithCommandAndShared(_) => f.write_str("WithCommandAndShared(handler)"),
            HandlerEntry::WithCanvasEvent(_) => f.write_str("WithCanvasEvent(handler)"),
        }
    }
}

impl HandlerRegistry {
    /// Create a new empty handler registry
    pub fn new() -> Self {
        Self {
            handlers: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Register a simple handler
    pub fn register_simple<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any) + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(name.to_string(), HandlerEntry::Simple(Arc::new(handler)));
        }
    }

    /// Register a handler with a value parameter
    pub fn register_with_value<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any, Box<dyn Any>) + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(name.to_string(), HandlerEntry::WithValue(Arc::new(handler)));
        }
    }

    /// Register a handler that returns a command
    pub fn register_with_command<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any) -> Box<dyn Any> + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(
                name.to_string(),
                HandlerEntry::WithCommand(Arc::new(handler)),
            );
        }
    }

    // ============================================
    // New registration methods for shared state
    // ============================================

    /// Register a handler that receives shared context.
    ///
    /// Use this for handlers that need to read or modify shared state
    /// that is accessible across multiple views.
    ///
    /// # Arguments
    ///
    /// * `name` - Handler name (referenced in XML `on_click="name"`)
    /// * `handler` - Function that receives `(&mut Model, &SharedContext<S>)`
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_with_shared("update_theme", |model, shared| {
    ///     let model = model.downcast_mut::<Model>().unwrap();
    ///     let shared = shared.downcast_ref::<SharedContext<SharedState>>().unwrap();
    ///     shared.write().theme = model.selected_theme.clone();
    /// });
    /// ```
    pub fn register_with_shared<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any, &dyn Any) + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(
                name.to_string(),
                HandlerEntry::WithShared(Arc::new(handler)),
            );
        }
    }

    /// Register a handler with both a value parameter and shared context.
    ///
    /// Use this for handlers that receive input (like text field values)
    /// and also need access to shared state.
    ///
    /// # Arguments
    ///
    /// * `name` - Handler name (referenced in XML `on_change="name"`)
    /// * `handler` - Function that receives `(&mut Model, Box<dyn Any>, &SharedContext<S>)`
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_with_value_and_shared("set_username", |model, value, shared| {
    ///     let model = model.downcast_mut::<Model>().unwrap();
    ///     let name = value.downcast_ref::<String>().unwrap();
    ///     let shared = shared.downcast_ref::<SharedContext<SharedState>>().unwrap();
    ///     shared.write().username = name.clone();
    /// });
    /// ```
    pub fn register_with_value_and_shared<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any, Box<dyn Any>, &dyn Any) + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(
                name.to_string(),
                HandlerEntry::WithValueAndShared(Arc::new(handler)),
            );
        }
    }

    /// Register a handler that receives shared context and returns a command.
    ///
    /// Use this for async handlers that need shared state access.
    ///
    /// # Arguments
    ///
    /// * `name` - Handler name (referenced in XML `on_click="name"`)
    /// * `handler` - Function that receives `(&mut Model, &SharedContext<S>) -> Command`
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_with_command_and_shared("sync_settings", |model, shared| {
    ///     let shared = shared.downcast_ref::<SharedContext<SharedState>>().unwrap();
    ///     let settings = shared.read().clone();
    ///     Box::new(Task::perform(save_settings(settings), Message::SettingsSaved))
    /// });
    /// ```
    pub fn register_with_command_and_shared<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any, &dyn Any) -> Box<dyn Any> + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(
                name.to_string(),
                HandlerEntry::WithCommandAndShared(Arc::new(handler)),
            );
        }
    }

    /// Register a handler that receives a canvas event
    pub fn register_canvas_event<F>(&self, name: &str, handler: F)
    where
        F: Fn(&mut dyn Any, CanvasEvent) + Send + Sync + 'static,
    {
        if let Ok(mut handlers) = self.handlers.write() {
            handlers.insert(
                name.to_string(),
                HandlerEntry::WithCanvasEvent(Arc::new(handler)),
            );
        }
    }

    /// Look up a handler by name
    pub fn get(&self, name: &str) -> Option<HandlerEntry> {
        self.handlers.read().ok()?.get(name).cloned()
    }

    /// Dispatches a handler by name, executing it with the provided model and optional value.
    ///
    /// This is a convenience method that combines `get()` and handler invocation.
    /// For handlers that require shared state, use [`dispatch_with_shared`](Self::dispatch_with_shared)
    /// instead.
    ///
    /// # Arguments
    ///
    /// * `handler_name` - Name of the handler to dispatch
    /// * `model` - Mutable reference to the model (as `&mut dyn Any`)
    /// * `value` - Optional string value passed to WithValue handlers
    ///
    /// # Note
    ///
    /// This method does NOT support `WithShared`, `WithValueAndShared`, or `WithCommandAndShared`
    /// handlers. Those handlers will be silently ignored. Use `dispatch_with_shared` instead.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_simple("greet", |model| {
    ///     let model = model.downcast_mut::<MyModel>().unwrap();
    ///     model.count += 1;
    /// });
    ///
    /// let model = &mut MyModel { count: 0 } as &mut dyn std::any::Any;
    /// registry.dispatch("greet", model, None);
    /// ```
    pub fn dispatch(&self, handler_name: &str, model: &mut dyn Any, value: Option<String>) {
        if let Some(entry) = self.get(handler_name) {
            match entry {
                HandlerEntry::Simple(h) => h(model),
                HandlerEntry::WithValue(h) => {
                    let val = value.unwrap_or_default();
                    h(model, Box::new(val));
                }
                HandlerEntry::WithCommand(h) => {
                    h(model);
                }
                // Shared handlers require shared context - silently skip in dispatch()
                HandlerEntry::WithShared(_)
                | HandlerEntry::WithValueAndShared(_)
                | HandlerEntry::WithCommandAndShared(_)
                | HandlerEntry::WithCanvasEvent(_) => {
                    // These handlers require shared context or event data. Use specific dispatch methods.
                }
            }
        }
    }

    /// Dispatches a handler by name and returns any command/task it produces.
    ///
    /// This method is similar to `dispatch()` but returns the command/task from
    /// `WithCommand` handlers instead of discarding it. This is essential for
    /// integrating with the Elm/MVU pattern where handlers can return tasks.
    ///
    /// For handlers that require shared state, use [`dispatch_with_shared`](Self::dispatch_with_shared)
    /// instead.
    ///
    /// # Arguments
    ///
    /// * `handler_name` - Name of the handler to dispatch
    /// * `model` - Mutable reference to the model (as `&mut dyn Any`)
    /// * `value` - Optional string value passed to WithValue handlers
    ///
    /// # Returns
    ///
    /// * `Some(Box<dyn Any>)` - The command/task from a `WithCommand` handler
    /// * `None` - For `Simple` and `WithValue` handlers, or if handler not found
    ///
    /// # Note
    ///
    /// This method does NOT support shared handlers. Use `dispatch_with_shared` instead.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    /// use iced::Task;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_with_command("navigate", |model| {
    ///     let model = model.downcast_mut::<MyModel>().unwrap();
    ///     Box::new(Task::done(Message::SwitchView))
    /// });
    ///
    /// let model = &mut MyModel::default() as &mut dyn std::any::Any;
    /// if let Some(boxed_task) = registry.dispatch_with_command("navigate", model, None) {
    ///     if let Ok(task) = boxed_task.downcast::<Task<Message>>() {
    ///         return *task;
    ///     }
    /// }
    /// ```
    pub fn dispatch_with_command(
        &self,
        handler_name: &str,
        model: &mut dyn Any,
        value: Option<String>,
    ) -> Option<Box<dyn Any>> {
        if let Some(entry) = self.get(handler_name) {
            match entry {
                HandlerEntry::Simple(h) => {
                    h(model);
                    None
                }
                HandlerEntry::WithValue(h) => {
                    let val = value.unwrap_or_default();
                    h(model, Box::new(val));
                    None
                }
                HandlerEntry::WithCommand(h) => Some(h(model)),
                // Shared handlers require shared context - not supported here
                HandlerEntry::WithShared(_)
                | HandlerEntry::WithValueAndShared(_)
                | HandlerEntry::WithCommandAndShared(_)
                | HandlerEntry::WithCanvasEvent(_) => None,
            }
        } else {
            None
        }
    }

    /// Dispatches a handler with shared context and returns any command it produces.
    ///
    /// This is the primary dispatch method for applications using shared state.
    /// It handles all handler variants, passing the shared context to variants
    /// that expect it.
    ///
    /// # Arguments
    ///
    /// * `handler_name` - Name of the handler to dispatch
    /// * `model` - Mutable reference to the local model (as `&mut dyn Any`)
    /// * `shared` - Reference to the shared context (as `&dyn Any`)
    /// * `value` - Optional string value passed to WithValue/WithValueAndShared handlers
    ///
    /// # Returns
    ///
    /// * `Some(Box<dyn Any>)` - The command from `WithCommand` or `WithCommandAndShared` handlers
    /// * `None` - For simple handlers, value handlers, or if handler not found
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use dampen_core::HandlerRegistry;
    ///
    /// let registry = HandlerRegistry::new();
    /// registry.register_with_shared("toggle_theme", |model, shared| {
    ///     let shared = shared.downcast_ref::<SharedContext<SharedState>>().unwrap();
    ///     let current = shared.read().dark_mode;
    ///     shared.write().dark_mode = !current;
    /// });
    ///
    /// let model = &mut Model::default() as &mut dyn std::any::Any;
    /// let shared = &shared_context as &dyn std::any::Any;
    /// registry.dispatch_with_shared("toggle_theme", model, shared, None);
    /// ```
    pub fn dispatch_with_shared(
        &self,
        handler_name: &str,
        model: &mut dyn Any,
        shared: &dyn Any,
        value: Option<String>,
    ) -> Option<Box<dyn Any>> {
        let entry = self.get(handler_name)?;

        match entry {
            // Existing variants (backward compatible - ignore shared)
            HandlerEntry::Simple(h) => {
                h(model);
                None
            }
            HandlerEntry::WithValue(h) => {
                h(model, Box::new(value.unwrap_or_default()));
                None
            }
            HandlerEntry::WithCommand(h) => Some(h(model)),

            // New shared variants
            HandlerEntry::WithShared(h) => {
                h(model, shared);
                None
            }
            HandlerEntry::WithValueAndShared(h) => {
                h(model, Box::new(value.unwrap_or_default()), shared);
                None
            }
            HandlerEntry::WithCommandAndShared(h) => Some(h(model, shared)),
            // Canvas handlers require event data - ignore here
            HandlerEntry::WithCanvasEvent(_) => None,
        }
    }

    /// Dispatch a canvas event handler
    pub fn dispatch_canvas_event(
        &self,
        handler_name: &str,
        model: &mut dyn Any,
        event: CanvasEvent,
    ) {
        if let Some(HandlerEntry::WithCanvasEvent(h)) = self.get(handler_name) {
            h(model, event);
        }
    }

    /// Check if a handler exists
    pub fn contains(&self, name: &str) -> bool {
        if let Ok(handlers) = self.handlers.read() {
            handlers.contains_key(name)
        } else {
            false
        }
    }
}

impl Default for HandlerRegistry {
    fn default() -> Self {
        Self::new()
    }
}

/// Handler metadata for compile-time validation
#[derive(Debug, Clone, PartialEq)]
pub struct HandlerSignature {
    /// Handler name
    pub name: String,

    /// Parameter type if applicable
    pub param_type: Option<String>,

    /// Whether handler returns Command
    pub returns_command: bool,
}

/// Build-time analysis structure for circular dependency detection
///
/// **Feature T130 - Not Yet Integrated**
///
/// This structure is used for static analysis of handler dependencies to detect
/// circular call chains at compile time. It is not yet integrated into the
/// handler registration or dispatch system.
///
/// # Example
///
/// ```rust,ignore
/// use dampen_core::handler::HandlerCallGraph;
///
/// let mut graph = HandlerCallGraph::new();
/// graph.add_dependency("handler_a", "handler_b");
/// graph.add_dependency("handler_b", "handler_c");
///
/// if let Some(cycle) = graph.detect_cycles() {
///     println!("Circular dependency detected: {:?}", cycle);
/// }
/// ```
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct HandlerCallGraph {
    /// Map of handler name to its dependencies
    dependencies: HashMap<String, Vec<String>>,
}

impl HandlerCallGraph {
    /// Create a new empty call graph
    pub fn new() -> Self {
        Self {
            dependencies: HashMap::new(),
        }
    }

    /// Add a dependency edge (from depends on to)
    pub fn add_dependency(&mut self, from: &str, to: &str) {
        self.dependencies
            .entry(from.to_string())
            .or_default()
            .push(to.to_string());
    }

    /// Detect if adding edge would create a cycle
    pub fn would_create_cycle(&self, from: &str, to: &str) -> bool {
        // Check if 'to' can reach 'from' (which would create a cycle)
        let mut visited = HashSet::new();
        self.can_reach(to, from, &mut visited)
    }

    /// Check if 'from' can reach 'to' via dependencies
    fn can_reach(&self, from: &str, to: &str, visited: &mut HashSet<String>) -> bool {
        if from == to {
            return true;
        }

        if visited.contains(from) {
            return false;
        }

        visited.insert(from.to_string());

        if let Some(deps) = self.dependencies.get(from) {
            for dep in deps {
                if self.can_reach(dep, to, visited) {
                    return true;
                }
            }
        }

        false
    }

    /// Get all handlers that depend on the given handler
    pub fn dependents_of(&self, handler: &str) -> Vec<String> {
        self.dependencies
            .iter()
            .filter_map(|(k, v)| {
                if v.contains(&handler.to_string()) {
                    Some(k.clone())
                } else {
                    None
                }
            })
            .collect()
    }

    /// Detect cycles in the call graph using DFS
    pub fn detect_cycles(&self) -> Option<Vec<String>> {
        let mut visited = HashSet::new();
        let mut recursion_stack = HashSet::new();
        let mut path = Vec::new();

        for handler in self.dependencies.keys() {
            if !visited.contains(handler)
                && let Some(cycle) =
                    self.dfs_detect_cycle(handler, &mut visited, &mut recursion_stack, &mut path)
            {
                return Some(cycle);
            }
        }

        None
    }

    fn dfs_detect_cycle(
        &self,
        handler: &str,
        visited: &mut HashSet<String>,
        recursion_stack: &mut HashSet<String>,
        path: &mut Vec<String>,
    ) -> Option<Vec<String>> {
        visited.insert(handler.to_string());
        recursion_stack.insert(handler.to_string());
        path.push(handler.to_string());

        if let Some(deps) = self.dependencies.get(handler) {
            for dep in deps {
                if !visited.contains(dep) {
                    if let Some(cycle) = self.dfs_detect_cycle(dep, visited, recursion_stack, path)
                    {
                        return Some(cycle);
                    }
                } else if recursion_stack.contains(dep) {
                    // Found a cycle - construct the cycle path
                    if let Some(cycle_start) = path.iter().position(|h| h == dep) {
                        let mut cycle = path[cycle_start..].to_vec();
                        cycle.push(dep.to_string());
                        return Some(cycle);
                    }
                }
            }
        }

        path.pop();
        recursion_stack.remove(handler);
        None
    }
}

impl Default for HandlerCallGraph {
    fn default() -> Self {
        Self::new()
    }
}

/// Canvas event data passed to handlers
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct CanvasEvent {
    pub kind: CanvasEventKind,
    pub x: f32,
    pub y: f32,
    pub delta_x: Option<f32>,
    pub delta_y: Option<f32>,
}

/// Type of canvas interaction
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub enum CanvasEventKind {
    Click,
    Drag,
    Move,
    Release,
}