zhc_ir 0.1.8

Graph-based intermediate representation framework with dialect support
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

use crate::{AnnIR, Dialect, IR, OpMap};
use std::path::Path;

mod composition;
mod hierarchy;
mod html;
mod layer_map;
mod layoutlang;
mod placement;
mod svg;

pub use hierarchy::*;
pub use layer_map::*;
pub use layoutlang::*;

#[cfg(test)]
mod test;

/// Draws an IR diagram to an SVG file.
///
/// Takes an IR with hierarchy annotations and produces an SVG visualization
/// showing the compound graph structure with operations, groups, and edges.
pub fn draw_ir<D: Dialect>(ir: &IR<D>, hierarchy_ann: OpMap<Hierarchy>, path: impl AsRef<Path>) {
    let stylesheet = composition::StyleSheet::new();

    // Create annotated IR with hierarchy information
    let ann_ir = AnnIR::new(ir, hierarchy_ann, ir.filled_valmap(()));

    // Generate layout IR from the annotated IR
    let layout_ir = generate_layout_ir(&ann_ir);

    // Run the placement algorithm (currently unused but computes depths/layers)
    let placed_ir = placement::place(&layout_ir);

    // Convert to positioned diagram with frame annotations
    let composed_ir = composition::compose(&placed_ir, &stylesheet);

    // Render to SVG
    let svg_output = svg::draw(&composed_ir, &stylesheet);
    let svg_content = format!("{}", svg_output);
    std::fs::write(path, svg_content).expect("Failed to write SVG file");
}

/// Draws an IR diagram to an HTML file with interactive zoom/pan.
///
/// Similar to `draw_ir` but outputs an HTML document that embeds the SVG
/// with better viewport handling and transform-based zoom/pan.
pub fn draw_ir_html<D: Dialect>(
    ir: &IR<D>,
    hierarchy_ann: OpMap<Hierarchy>,
    path: impl AsRef<Path>,
) {
    let stylesheet = composition::StyleSheet::new();

    let ann_ir = AnnIR::new(ir, hierarchy_ann, ir.filled_valmap(()));

    let layout_ir = generate_layout_ir(&ann_ir);
    let placed_ir = placement::place(&layout_ir);
    let composed_ir = composition::compose(&placed_ir, &stylesheet);

    let svg_output = svg::draw(&composed_ir, &stylesheet);
    let html_output = html::wrap_svg(svg_output);
    let html_content = format!("{}", html_output);
    std::fs::write(path, html_content).expect("Failed to write HTML file");
}