1# modules/mirada/ — Compositor Wayland (carmen)
2
3**Propósito.** Un compositor Wayland teselante. La decisión de diseño
4central es partirlo en dos procesos, el **Cerebro** y el **Cuerpo**:
5
6- **El Cuerpo** (`mirada-compositor`, sobre `smithay`) habla Wayland con
7  los clientes, posee el hardware (DRM/GPU/libinput) y compone las
8  superficies reales. Los píxeles nunca salen de él — composición
9  *zero-copy*.
10- **El Cerebro** (la app `mirada`, GPUI) decide *dónde* va cada ventana
11  —pura aritmética de rectángulos— y orquesta el escritorio: layouts,
12  atajos, focos, escritorios virtuales.
13
14Los dos hablan por un socket Unix con un contrato mínimo de enums. Así,
15toda la lógica espacial es agnóstica de Wayland y se prueba sin un
16servidor gráfico; el Cuerpo queda reducido a "habla el protocolo y
17ejecuta operaciones de geometría".
18
19## Crates
20
21| crate              | tipo     | rol                                                                    |
22| ------------------ | -------- | ---------------------------------------------------------------------- |
23| `mirada-layout`    | lib      | Motor de teselado: `Rect`, modos de layout, `Workspace` (ventanas, foco) |
24| `mirada-protocol`  | lib      | Contrato Cerebro↔Cuerpo: `BrainCommand`/`BodyEvent` + marco de cable   |
25| `mirada-brain`     | lib      | Orquestador del escritorio: `Desktop`, eventos→comandos, atajos        |
26| `mirada-link`      | lib      | Transporte: el socket Unix con hilo lector + canal                     |
27| `mirada-body`      | lib      | Contabilidad del Cuerpo: `BodyState`, traduce comandos a `BodyOp`      |
28| `mirada` (app)     | bin/GPUI | El Cerebro: ventana que tesela el escritorio y manda geometría         |
29| `mirada-compositor`| bin/smithay | El Cuerpo: compositor Wayland real (backend `winit`, anidado)        |
30| `mirada-ctl` (app) | bin/CLI  | Control externo del Cerebro (estilo `swaymsg`): acciones y consultas   |
31
32## Flujo
33
34```text
35  mirada-layout ─► mirada-protocol ─► mirada-brain ─► [app mirada · Cerebro]
36                          │                                  │
37                          │                            mirada-link
38                          │                                  │
39                          └────► mirada-body ─► [mirada-compositor · Cuerpo]
40```
41
42- El Cuerpo reporta hardware/clientes con `BodyEvent` (salida conectada,
43  ventana abierta, atajo pulsado…).
44- El Cerebro (`Desktop::on_event`) recalcula y emite `BrainCommand`
45  (`Place` con la geometría completa, `Close`, `GrabKeys`…).
46- El Cuerpo (`BodyState::apply`) traduce cada comando a `BodyOp`
47  concretas y sólo emite lo que de verdad cambia.
48
49## Detalle por crate
50
51- **`mirada-layout`** — `Rect` + `split` (reparto exacto de píxeles),
52  `LayoutMode` con 7 modos (`MasterStack`, `CenteredMaster`, `Spiral`
53  —espiral de Fibonacci—, `Grid`, `Columns`, `Rows`, `Monocle`) y
54  `LayoutMode::next()` para el ciclo, `Workspace` con foco cíclico,
55  reordenado y `promote_focused`. `LayoutParams` lleva `master_ratio` y
56  `master_count` (`nmaster`); *smart gaps* (una sola ventana va a
57  sangre). Determinista.
58- **`mirada-protocol`** — `WindowPlacement`, los enums `BrainCommand` y
59  `BodyEvent`, el marco `postcard` con prefijo `u32` LE
60  (`write_frame`/`read_frame`, guard `MAX_FRAME`) y el puente
61  `placements(&Workspace, Rect)`.
62- **`mirada-brain`** — `Desktop`: salidas, 9 escritorios virtuales,
63  registro de ventanas. `on_event(BodyEvent) -> Vec<BrainCommand>`;
64  `DesktopAction` + `Keymap` configurable (`set_keymap` en caliente) +
65  `Rules` de ventana. **Multi-monitor**: cada `Output` muestra un
66  escritorio; `relayout()` tesela todas las salidas en un solo `Place`.
67- **`mirada-link`** — `Link<Out,In>` sobre socket Unix; hilo lector de
68  fondo + canal `mpsc` para sondeo no bloqueante. `BrainLink`/`BodyLink`,
69  `connected_pair` (socketpair), `connect`/`listen` por ruta.
70- **`mirada-body`** — `BodyState`: salidas + superficies; `apply` traduce
71  `BrainCommand`→`BodyOp` (idempotente), los mutadores del backend
72  devuelven los `BodyEvent` a mandar. Ejemplo `headless`: un Cuerpo sin
73  gráficos guiado por stdin para ejercitar el bucle entero.
74- **`mirada` (app)** — envuelve `Desktop` y lo pinta (barra de
75  escritorios + modo + foco, lienzo teselado). El lienzo dibuja **todas
76  las salidas a escala**, cada una con su marco. Con `MIRADA_SOCKET`
77  conecta a un Cuerpo; sin él corre en **simulación** (ventanas
78  sintéticas, teclado de la propia ventana). Pips de escritorio y
79  ventanas clicables.
80- **`mirada-ctl` (app)** — CLI de control: parsea la acción de los
81  argumentos (`DesktopAction: FromStr`) y la manda al Cerebro por el
82  socket de control; `windows` y `actions` para consultar.
83
84## Atajos de teclado configurables
85
86El keymap vive **sólo en el Cerebro** (`mirada-brain::Keymap`). El Cuerpo
87nunca lo ve: recibe únicamente la lista de cadenas a interceptar en un
88`GrabKeys`, hace un `Vec::contains` ciego y devuelve la combinación
89pulsada como `Keybind`; es `Desktop` quien la traduce a `DesktopAction`.
90Esa separación —*qué* interceptar (lista barata, Cuerpo) vs. *qué
91significa* (el mapa, Cerebro)— hace innecesario cualquier candado o
92`Arc`: el mapa es monohilo y la lista se reemplaza de golpe.
93
94- **Disco** — RON de texto en `~/.config/mirada/keymap.ron`, editable a
95  mano y versionable. La app lo crea documentado en el primer arranque;
96  si está corrupto, avisa y usa el de por defecto sin pisar el archivo.
97- **Cable** — sólo viaja la lista de cadenas (`GrabKeys`), vía el marco
98  `postcard` que ya existe. No hay formato binario de configuración.
99- **Vocabulario** — la acción es una cadena estable (`"focus-next"`,
100  `"layout:grid"`, `"workspace:3"`): `DesktopAction: Display + FromStr`.
101- **Recarga en caliente** — `Keymap::watch` (sobre `notify`) vigila el
102  archivo; al cambiar, el dueño del `Desktop` recarga, llama a
103  `set_keymap` y reenvía el `GrabKeys`. Sin reiniciar.
104- **Configurador** — no hay ejecutable aparte: el editor de texto del
105  usuario, y la app `mirada` (que a futuro puede dibujar un editor visual
106  sobre el mismo API `Keymap`). `cargo run -p mirada-brain --example
107  keymap-default` imprime el archivo por defecto.
108
109## API de acciones
110
111Toda acción de escritorio converge en un único embudo:
112`Desktop::apply(DesktopAction) -> Vec<BrainCommand>`. El keymap no es más
113que un front-end (`Keybind` → `lookup` → `apply`); hay otros tres:
114
115- **`DesktopAction::FocusWindow(WindowId)`** — direccionamiento directo de
116  una ventana (no sólo ciclar con `FocusNext`/`Prev`); si está en otro
117  escritorio, salta a él. Lo usan la taskbar y `mirada-ctl`.
118- **Ventanas flotantes** — `ToggleFloat` (`Super+f`) saca la enfocada del
119  teselado a un rectángulo libre (centrado, 60 %); `Workspace` guarda las
120  flotantes aparte, `layout()` las pone al final y `WindowPlacement`
121  /`BodyOp::Configure` llevan `floating: bool` para que el Cuerpo las
122  componga por encima.
123- **Pantalla completa** — `ToggleFullscreen` (`Super+Shift+f`): la ventana
124  cubre toda la salida (sin gap), oculta al resto y se lleva el foco;
125  `Workspace.fullscreen: Option<WindowId>`, y el Cuerpo le fija el estado
126  `xdg_toplevel Fullscreen`. También atiende la petición del propio
127  cliente (`xdg set_fullscreen` → `BodyEvent::FullscreenRequest`), así
128  que un reproductor o un juego entran a pantalla completa solos.
129- **Multi-monitor** — cada `Output` muestra un escritorio distinto;
130  `SwitchWorkspace` actúa sobre la salida enfocada (y la intercambia si
131  el escritorio pedido ya lo muestra otra salida); `FocusOutputNext`
132  (`Super+o`) mueve el foco entre monitores. El foco del teclado es
133  único — sólo la ventana enfocada de la salida enfocada.
134- **Scratchpad** — `SendToScratchpad` guarda la ventana enfocada (sale
135  del teselado, en ningún escritorio); `ToggleScratchpad` (`` Super+` ``)
136  la invoca flotando y centrada en el escritorio actual, o la oculta —
137  estilo terminal desplegable. `Desktop.scratchpad: Vec<WindowId>`;
138  `mirada-ctl windows` la lista como `esc scratch`.
139- **Layout y área maestra por el API** — los 7 modos se intercambian
140  (`SetLayout`/`CycleLayout`, `mirada-ctl layout spiral`); el área
141  maestra se redimensiona (`grow`/`shrink-master`, `Super+l`/`Super+h`);
142  `inc`/`dec-master` cambian `nmaster` (`Super+,`/`Super+.`); y
143  `promote-to-master` lleva la enfocada al puesto maestro (`Super+Return`
144  — `combo_string` ya canoniza teclas con nombre: `Return`, `Tab`, `F5`…).
145- **HUD interactivo** (app `mirada`) — los pips de escritorio y las
146  ventanas del lienzo son clicables: clic = `apply` de la acción.
147- **`mirada-ctl`** — control externo por línea de comandos
148  (`mirada-ctl focus-next`, `workspace 3`, `windows`). Habla con el
149  Cerebro por un socket Unix aparte; el módulo `mirada-brain::ctl` define
150  `CtlRequest`/`CtlReply` (marco `postcard`), `CtlServer`/`CtlConn` y
151  `send_request`. El Cerebro (la app `mirada` siempre; `mirada-compositor`
152  sólo embebido) abre el socket y atiende en su bucle. `DesktopAction`
153  viaja como enum serializado: contrato tipado de punta a punta.
154
155`cargo run -p mirada-brain --example headless-ctl` levanta un Cerebro sin
156gráficos para ejercitar `mirada-ctl` en modo desatendido.
157
158## Reglas de ventana
159
160`mirada-brain::rules` decide qué hacer con una ventana **al abrirse**:
161config declarativa en RON (`~/.config/mirada/rules.ron`), mismo patrón
162que el keymap. Cada `Rule` casa por subcadena de `app_id` y/o `title`
163(sin distinguir mayúsculas; vacío = cualquiera) y aplica un destino:
164`workspace` (1..9) y/o `floating`. Gana la primera regla que case.
165
166El `Desktop` consulta `Rules::resolve` en cada `WindowOpened` — el evento
167ya trae `app_id`/`title` — y manda la ventana a su escritorio, flotando
168si toca. Se carga al arrancar (la primera vez se escribe una plantilla
169con ejemplos comentados); las reglas afectan a las ventanas futuras, no
170a las ya abiertas.
171
172## Dependencias
173
174- Todos los `lib` con `#![forbid(unsafe_code)]`. Cero Wayland, cero
175  `smithay` en los seis crates de arriba.
176- El acoplamiento a Wayland/hardware vive sólo en `mirada-compositor`.
177
178## Estado
179
180Implementado y verde: `mirada-layout` (32 tests), `mirada-protocol`
181(11), `mirada-brain` (65), `mirada-link` (7), `mirada-body` (14), las
182apps `mirada` y `mirada-compositor` (compilan; verificación visual
183manual) y `mirada-ctl` (CLI, probado vía el ejemplo `headless-ctl`).
184
185El **Cuerpo** ya existe: `mirada-compositor` es un compositor Wayland
186teselante real sobre `smithay`, con backend `winit` — corre **anidado**
187como una ventana dentro de la sesión gráfica actual. Habla
188`wl_compositor`/`xdg_shell`/`wl_shm`/`wl_seat`/`wl_data_device`, compone
189las superficies de los clientes con `GlesRenderer` y aplica la geometría
190del Cerebro. Reusa `mirada-body` (contabilidad) y `mirada-link` (cable).
191Dos modos: **autónomo** (Cerebro `Desktop` embebido, un solo proceso) o
192**enlazado** (`MIRADA_SOCKET` → la app `mirada` decide la geometría).
193Compila y pasa clippy; verificación visual manual — ver
194`crates/apps/mirada-compositor/README.md`.
195
196**Pendiente** — refinamientos del Cuerpo, no verificables en modo
197desatendido:
198
199| capa pendiente       | rol                                                      |
200| -------------------- | -------------------------------------------------------- |
201| backend DRM/libinput | de `winit` anidado a sesión nativa: superficies KMS, GPU |
202| `mirada-input`       | puntero/ratón completo, repetición de teclas, gestos     |
203| `mirada-sandbox`     | aislamiento de clientes sobre `arje-incarnate`           |
204
205CRIU (congelar/restaurar ventanas) queda anotado como futuro.