mmdflux 2.5.0

Render Mermaid diagrams as Unicode text, ASCII, SVG, and MMDS JSON.
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
//! SVG label placement and emission helpers for graph rendering.

use std::collections::HashMap;

use super::text::{
    BackgroundStyle, TextRenderStyle, font_attrs_for_style, render_text_centered,
    render_text_centered_with_wrap,
};
use super::{GraphSvgPalette, Point, dynamic_css_attrs};
use crate::graph::geometry::{EdgeLabelGeometry, GraphGeometry};
use crate::graph::measure::{GraphTextStyleKey, TextMetricsProvider, edge_text_style_key};
use crate::graph::routing::compute_end_label_positions;
use crate::graph::{Edge, Graph, Stroke};
use crate::render::svg::SvgWriter;

const LABEL_ANCHOR_REVALIDATION_MAX_DISTANCE: f64 = 2.0;
const LABEL_POINT_EPS: f64 = 0.000_001;

pub(super) struct ResolvedEdgeLabel<'a> {
    pub(super) center: Point,
    pub(super) geometry: Option<&'a EdgeLabelGeometry>,
}

fn revalidate_svg_label_anchor(candidate: Point, rendered_path: Option<&[Point]>) -> Point {
    let Some(path) = rendered_path else {
        return candidate;
    };
    if path.is_empty() {
        return candidate;
    }

    let drift = distance_point_to_svg_path(candidate, path);
    if drift <= LABEL_ANCHOR_REVALIDATION_MAX_DISTANCE {
        return candidate;
    }
    svg_path_midpoint(path).unwrap_or(candidate)
}

fn point_distance_svg(a: Point, b: Point) -> f64 {
    ((a.x - b.x).powi(2) + (a.y - b.y).powi(2)).sqrt()
}

fn distance_point_to_svg_segment(point: Point, a: Point, b: Point) -> f64 {
    let dx = b.x - a.x;
    let dy = b.y - a.y;
    let seg_len_sq = dx * dx + dy * dy;
    if seg_len_sq <= LABEL_POINT_EPS {
        return point_distance_svg(point, a);
    }
    let projection = ((point.x - a.x) * dx + (point.y - a.y) * dy) / seg_len_sq;
    let t = projection.clamp(0.0, 1.0);
    let closest = Point {
        x: a.x + t * dx,
        y: a.y + t * dy,
    };
    point_distance_svg(point, closest)
}

fn distance_point_to_svg_path(point: Point, path: &[Point]) -> f64 {
    if path.is_empty() {
        return f64::INFINITY;
    }
    if path.len() == 1 {
        return point_distance_svg(point, path[0]);
    }
    path.windows(2)
        .map(|segment| distance_point_to_svg_segment(point, segment[0], segment[1]))
        .fold(f64::INFINITY, f64::min)
}

fn svg_path_midpoint(path: &[Point]) -> Option<Point> {
    if path.is_empty() {
        return None;
    }
    if path.len() == 1 {
        return path.first().copied();
    }
    let total_len: f64 = path
        .windows(2)
        .map(|segment| point_distance_svg(segment[0], segment[1]))
        .sum();
    if total_len <= LABEL_POINT_EPS {
        return path.get(path.len() / 2).copied();
    }

    let target = total_len / 2.0;
    let mut traversed = 0.0;
    for segment in path.windows(2) {
        let a = segment[0];
        let b = segment[1];
        let seg_len = point_distance_svg(a, b);
        if seg_len <= LABEL_POINT_EPS {
            continue;
        }
        if traversed + seg_len >= target {
            let t = (target - traversed) / seg_len;
            return Some(Point {
                x: a.x + (b.x - a.x) * t,
                y: a.y + (b.y - a.y) * t,
            });
        }
        traversed += seg_len;
    }
    path.last().copied()
}

#[allow(clippy::too_many_arguments)]
pub(super) fn render_edge_labels(
    writer: &mut SvgWriter,
    diagram: &Graph,
    geom: &GraphGeometry,
    self_edge_paths: &HashMap<usize, Vec<Point>>,
    rendered_edge_paths: &HashMap<usize, Vec<Point>>,
    override_nodes: &HashMap<String, String>,
    metrics: &dyn TextMetricsProvider,
    default_text_style: &GraphTextStyleKey,
    scale: f64,
    palette: &GraphSvgPalette,
) {
    let dynamic_attrs = dynamic_css_attrs(
        palette.dynamic_css,
        "graph-edge-text",
        &["fill:var(--_text);"],
    );
    let bg_dynamic_attrs = dynamic_css_attrs(
        palette.dynamic_css,
        "graph-edge-label-bg",
        &["fill:var(--bg);"],
    );
    let bg_style = BackgroundStyle {
        fill: &palette.edge_label_background,
        extra_attrs: bg_dynamic_attrs.as_str(),
        size: None,
    };

    writer.start_group("edgeLabels");

    for edge in diagram.edges.iter() {
        if edge.stroke == Stroke::Invisible {
            continue;
        }
        let Some(label) = edge.label.as_ref() else {
            continue;
        };
        let Some(resolved_label) = resolve_edge_label(
            diagram,
            edge,
            geom,
            self_edge_paths,
            rendered_edge_paths,
            override_nodes,
        ) else {
            continue;
        };
        let layout_edge = geom.edges.iter().find(|e| e.index == edge.index);
        // Prefer the post-lane re-wrap output when the routing pass decided
        // to narrow this edge's label. Falling back to
        // `edge.wrapped_label_lines` (pre-engine wrap) when no re-wrap
        // happened keeps non-overflowing edges byte-stable.
        //
        // Why not mutate `edge.wrapped_label_lines` upstream? The kernel's
        // Grid-mode measurement reads that artifact during layout. By the
        // time re-wrap fires (post-routing) layout is frozen; propagating
        // the narrower lines back to the shared source would silently
        // de-synchronize Grid-measured heights from Text output. See the
        // `graph/routing/label_rewrap.rs` module header for the full
        // design note.
        let wrap_lines = layout_edge
            .and_then(|e| e.effective_wrapped_lines.as_deref())
            .or(edge.wrapped_label_lines.as_deref());
        let text_style = edge_text_style_key(metrics, edge);
        let text_attrs =
            dynamic_attrs.clone() + &font_attrs_for_style(default_text_style, &text_style);
        render_text_centered_with_wrap(
            writer,
            Point {
                x: resolved_label.center.x * scale,
                y: resolved_label.center.y * scale,
            },
            label,
            wrap_lines,
            metrics,
            scale,
            TextRenderStyle {
                color: &palette.edge_label_text,
                extra_attrs: text_attrs.as_str(),
                text_style: Some(&text_style),
                background: Some(BackgroundStyle {
                    fill: bg_style.fill,
                    extra_attrs: bg_style.extra_attrs,
                    size: resolved_label
                        .geometry
                        .map(|g| (g.rect.width, g.rect.height)),
                }),
            },
        );
    }

    // Render head/tail end labels from routed edge paths.
    for edge in diagram.edges.iter() {
        if edge.head_label.is_none() && edge.tail_label.is_none() {
            continue;
        }
        // Get the routed path for this edge from geometry.
        let path: Vec<Point> = geom
            .edges
            .iter()
            .find(|e| e.index == edge.index)
            .and_then(|e| e.layout_path_hint.clone())
            .unwrap_or_default();
        if path.len() < 2 {
            continue;
        }
        let (head_pos, tail_pos) = compute_end_label_positions(&path);
        let text_style = edge_text_style_key(metrics, edge);
        let text_attrs =
            dynamic_attrs.clone() + &font_attrs_for_style(default_text_style, &text_style);
        if let (Some(label), Some(pos)) = (&edge.head_label, head_pos) {
            render_text_centered(
                writer,
                Point {
                    x: pos.x * scale,
                    y: pos.y * scale,
                },
                label,
                metrics,
                scale,
                TextRenderStyle {
                    color: &palette.edge_label_text,
                    extra_attrs: text_attrs.as_str(),
                    text_style: Some(&text_style),
                    background: Some(BackgroundStyle {
                        fill: bg_style.fill,
                        extra_attrs: bg_style.extra_attrs,
                        size: None,
                    }),
                },
            );
        }
        if let (Some(label), Some(pos)) = (&edge.tail_label, tail_pos) {
            render_text_centered(
                writer,
                Point {
                    x: pos.x * scale,
                    y: pos.y * scale,
                },
                label,
                metrics,
                scale,
                TextRenderStyle {
                    color: &palette.edge_label_text,
                    extra_attrs: text_attrs.as_str(),
                    text_style: Some(&text_style),
                    background: Some(BackgroundStyle {
                        fill: bg_style.fill,
                        extra_attrs: bg_style.extra_attrs,
                        size: None,
                    }),
                },
            );
        }
    }

    writer.end_group();
}

pub(super) fn resolve_edge_label<'a>(
    diagram: &Graph,
    edge: &Edge,
    geom: &'a GraphGeometry,
    self_edge_paths: &HashMap<usize, Vec<Point>>,
    rendered_edge_paths: &HashMap<usize, Vec<Point>>,
    override_nodes: &HashMap<String, String>,
) -> Option<ResolvedEdgeLabel<'a>> {
    let edge_idx = edge.index;
    let cross_boundary = if edge.from_subgraph.is_none() && edge.to_subgraph.is_none() {
        let from_override = override_nodes.get(&edge.from);
        let to_override = override_nodes.get(&edge.to);
        matches!(
            (from_override, to_override),
            (Some(a), Some(b)) if a != b
        ) || matches!(
            (from_override, to_override),
            (Some(_), None) | (None, Some(_))
        )
    } else {
        false
    };
    let use_precomputed =
        edge.from_subgraph.is_none() && edge.to_subgraph.is_none() && !cross_boundary;

    let layout_edge = geom.edges.iter().find(|e| e.index == edge_idx);
    let label_geom = layout_edge.and_then(|e| e.label_geometry.as_ref());
    // The lane-assignment pass writes `label_geometry` with either
    // `track != 0` (numerical displacement) or `compartment_size > 1`
    // (coordinated placement inside a multi-edge group, even when the
    // member happens to sit on track 0 relative to the shared anchor).
    // For either signal, trust the center directly — re-validating would snap
    // coordinated labels back to this edge's own path midpoint and undo the
    // shared-anchor placement. For singleton track-0 edges, keep revalidation:
    // those centers can drift from the rendered SVG path.
    //
    // Exception: labels crossing between sibling subgraphs intentionally use
    // the compound label-dummy slot, even when they are not lane-shifted.
    let sibling_compound_center = label_geom
        .filter(|_| edge_crosses_sibling_subgraphs(diagram, geom, edge))
        .map(|g| g.center);
    let lane_shifted_center = label_geom
        .filter(|g| (g.track != 0 || g.compartment_size > 1) && use_precomputed)
        .map(|g| g.center);
    if let Some(center) = sibling_compound_center.or(lane_shifted_center) {
        return Some(ResolvedEdgeLabel {
            center,
            geometry: label_geom,
        });
    }

    let candidate = if use_precomputed {
        label_geom
            .map(|g| g.center)
            .or_else(|| layout_edge.and_then(|e| e.label_position))
    } else {
        None
    }
    .or_else(|| fallback_label_position(geom, edge_idx, self_edge_paths, rendered_edge_paths));

    let center = candidate.map(|candidate| {
        revalidate_svg_label_anchor(
            candidate,
            rendered_edge_paths
                .get(&edge_idx)
                .map(|path| path.as_slice()),
        )
    })?;
    Some(ResolvedEdgeLabel {
        center,
        geometry: label_geom,
    })
}

fn edge_crosses_sibling_subgraphs(
    diagram: &Graph,
    geom: &GraphGeometry,
    edge: &crate::graph::Edge,
) -> bool {
    let Some(from_parent) = node_parent_id(diagram, geom, &edge.from) else {
        return false;
    };
    let Some(to_parent) = node_parent_id(diagram, geom, &edge.to) else {
        return false;
    };
    if from_parent == to_parent {
        return false;
    }

    let from_grandparent = diagram
        .subgraphs
        .get(&from_parent)
        .and_then(|sg| sg.parent.as_deref());
    let to_grandparent = diagram
        .subgraphs
        .get(&to_parent)
        .and_then(|sg| sg.parent.as_deref());
    from_grandparent.is_some() && from_grandparent == to_grandparent
}

fn node_parent_id(diagram: &Graph, geom: &GraphGeometry, node_id: &str) -> Option<String> {
    if let Some(parent) = geom
        .nodes
        .get(node_id)
        .and_then(|node| node.parent.as_deref())
    {
        return Some(parent.to_string());
    }
    diagram
        .subgraphs
        .values()
        .find(|subgraph| subgraph.nodes.iter().any(|member| member == node_id))
        .map(|subgraph| subgraph.id.clone())
}

pub(super) fn fallback_label_position(
    geom: &GraphGeometry,
    edge_index: usize,
    self_edge_paths: &HashMap<usize, Vec<Point>>,
    rendered_edge_paths: &HashMap<usize, Vec<Point>>,
) -> Option<Point> {
    if let Some(points) = self_edge_paths.get(&edge_index) {
        return svg_path_midpoint(points).or_else(|| points.get(points.len() / 2).copied());
    }

    // Try regular edges via layout_path_hint
    if let Some(layout_edge) = geom.edges.iter().find(|e| e.index == edge_index)
        && let Some(path) = &layout_edge.layout_path_hint
    {
        return path.get(path.len() / 2).copied();
    }

    // Try self-edges
    if let Some(se) = geom.self_edges.iter().find(|e| e.edge_index == edge_index) {
        return se.points.get(se.points.len() / 2).copied();
    }

    if let Some(points) = rendered_edge_paths.get(&edge_index) {
        return svg_path_midpoint(points).or_else(|| points.get(points.len() / 2).copied());
    }

    None
}

#[cfg(test)]
mod tests {
    use std::collections::{HashMap, HashSet};

    use super::{Point, revalidate_svg_label_anchor, svg_path_midpoint};
    use crate::graph::geometry::{EdgeLabelGeometry, EdgeLabelSide, GraphGeometry, LayoutEdge};
    use crate::graph::space::{FPoint, FRect};
    use crate::graph::{Direction, Edge, Graph};

    #[test]
    fn revalidate_svg_label_anchor_keeps_nearby_anchor() {
        let candidate = Point { x: 5.0, y: 1.0 };
        let path = [Point { x: 0.0, y: 0.0 }, Point { x: 10.0, y: 0.0 }];

        assert_eq!(
            revalidate_svg_label_anchor(candidate, Some(&path)),
            candidate
        );
    }

    #[test]
    fn revalidate_svg_label_anchor_falls_back_to_path_midpoint_when_drifted() {
        let candidate = Point { x: 50.0, y: 25.0 };
        let path = [Point { x: 0.0, y: 0.0 }, Point { x: 10.0, y: 0.0 }];

        assert_eq!(
            revalidate_svg_label_anchor(candidate, Some(&path)),
            Point { x: 5.0, y: 0.0 }
        );
    }

    #[test]
    fn svg_path_midpoint_handles_multi_segment_paths_by_distance() {
        let path = [
            Point { x: 0.0, y: 0.0 },
            Point { x: 6.0, y: 0.0 },
            Point { x: 6.0, y: 6.0 },
        ];

        assert_eq!(svg_path_midpoint(&path), Some(Point { x: 6.0, y: 0.0 }));
    }

    /// Constructs a minimal GraphGeometry with one LayoutEdge that has
    /// `label_position` set. The LayoutEdge starts with `label_geometry: None`.
    fn minimal_geom_with_labeled_edge() -> GraphGeometry {
        GraphGeometry {
            nodes: HashMap::new(),
            edges: vec![LayoutEdge {
                index: 0,
                from: "A".into(),
                to: "B".into(),
                waypoints: vec![],
                label_position: Some(FPoint::new(50.0, 50.0)),
                label_side: None,
                from_subgraph: None,
                to_subgraph: None,
                layout_path_hint: Some(vec![FPoint::new(50.0, 0.0), FPoint::new(50.0, 100.0)]),
                preserve_orthogonal_topology: false,
                label_geometry: None,
                effective_wrapped_lines: None,
            }],
            subgraphs: HashMap::new(),
            self_edges: vec![],
            direction: Direction::TopDown,
            node_directions: HashMap::new(),
            bounds: FRect::new(0.0, 0.0, 100.0, 100.0),
            reversed_edges: vec![],
            engine_hints: None,
            grid_projection: None,
            rerouted_edges: HashSet::new(),
            enhanced_backward_routing: false,
        }
    }

    fn minimal_labeled_edge() -> Edge {
        let mut edge = Edge::new("A", "B").with_label("yes");
        edge.index = 0;
        edge
    }

    #[test]
    fn svg_labels_uses_label_geometry_center_when_present() {
        let mut geom = minimal_geom_with_labeled_edge();
        let empty_map: HashMap<usize, Vec<Point>> = HashMap::new();

        // Set label_geometry with a center far from the normal label_position.
        geom.edges[0].label_geometry = Some(EdgeLabelGeometry {
            center: FPoint::new(123.0, 456.0),
            rect: FRect::new(113.0, 451.0, 20.0, 10.0),
            padding: (4.0, 2.0),
            side: EdgeLabelSide::Above,
            track: 0,
            compartment_size: 1,
        });

        // With no rendered path available, the resolved label remains at the
        // geometry center.
        let empty_overrides = HashMap::new();
        let center = super::resolve_edge_label(
            &Graph::new(Direction::TopDown),
            &minimal_labeled_edge(),
            &geom,
            &empty_map,
            &empty_map,
            &empty_overrides,
        )
        .map(|label| label.center);
        assert_eq!(
            center,
            Some(FPoint::new(123.0, 456.0)),
            "must use label_geometry.center when no rendered path can revalidate it"
        );
    }

    #[test]
    fn svg_labels_falls_back_to_label_position_when_no_label_geometry() {
        let geom = minimal_geom_with_labeled_edge();
        let empty_map: HashMap<usize, Vec<Point>> = HashMap::new();
        let empty_overrides = HashMap::new();

        // label_geometry is None, so it should fall back to precomputed label_position.
        let center = super::resolve_edge_label(
            &Graph::new(Direction::TopDown),
            &minimal_labeled_edge(),
            &geom,
            &empty_map,
            &empty_map,
            &empty_overrides,
        )
        .map(|label| label.center);
        assert_eq!(
            center,
            Some(FPoint::new(50.0, 50.0)),
            "must fall back to label_position when label_geometry is None"
        );
    }
}