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
//! FlowWM — the single top-level orchestrator for the `flowd` daemon.
//!
//! [`FlowWM`] owns all subsystems and routes events between them.
//! It is the entire application — there is no "daemon core" or higher-level
//! wrapper. Construction performs all startup work (config loading, window
//! scanning, layout initialisation, animation setup, hook registration).
//! Calling [`run()`](FlowWM::run) enters the IPC event loop.
//!
//! # Threading & event routing
//!
//! Two threads, no `Arc<Mutex>`. The background hook thread runs the WinEvent
//! callbacks and only sends [`HookEvent`]s through an `mpsc` channel — it never
//! touches any flow field. The main IPC thread owns the whole
//! [`FlowWM`] and, between IPC messages, drains the channel and
//! calls `&mut self` methods on the registry, layout, and animator. Because
//! every subsystem method takes `&mut self`, the borrow checker enforces
//! exclusive access at compile time — strictly safer than a runtime `Mutex`.
//!
//! - **Hook events**: Win32 hook → `HookEvent` → `on_window_created/destroyed/…`
//! → registry mutation → layout change → `animate_layout`.
//! - **IPC commands**: `flow` CLI → `SocketMessage` → `dispatch()` → layout /
//! registry query → `animate_layout` → `SocketResponse`.
//!
//! # Module structure
//!
//! The daemon module is split into focused submodules:
//!
//! - [`types`] — struct definitions ([`FlowWM`] and [`LayoutConfig`])
//! - [`new`] — constructor ([`FlowWM::new`])
//! - [`run`] — main event loop ([`FlowWM::run`] and event routing)
//! - [`hooks`] — Win32 hook event handlers
//! - [`borders`] — border overlay lifecycle (attach/detach/recolor helpers)
//! - [`dispatch`] — IPC command dispatch router and action handlers
//! - [`query`] — query handlers (extracted from dispatch)
//! - [`animation`] — animation bridge ([`FlowWM::animate_layout`])
//! - [`config_derive`] — configuration derivation helpers and tests
//! - [`shutdown`] — graceful-shutdown window rescue
//! ([`FlowWM::rescue_stranded_windows`])
//!
//! The threading model, the hook/IPC event pipelines, and per-event behavior
//! tables are documented with sequence diagrams in the developer guide
//! (`docs/src/dev-guide/threading-model.md` and `event-pipelines.md`).
pub use FlowWM;