jellyflow-layout 0.1.0

Optional headless graph layout adapters for Jellyflow.
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

//! Optional headless layout adapters for Jellyflow.
//!
//! This crate keeps automatic layout outside the core document model. Layout engines receive a
//! projection of a Jellyflow graph and return normal [`GraphTransaction`] values that hosts can
//! apply explicitly.

#![deny(unsafe_code)]

mod dugong;
mod engine;
mod family;
mod freeform;
mod mind_map;

pub use dugong::{
    DugongLayoutEngine, layout_graph_to_transaction_with_dugong, layout_graph_with_dugong,
};
pub use engine::{
    DUGONG_LAYOUT_ENGINE_ID, LayoutContext, LayoutDirection, LayoutEdgeRoute, LayoutEngine,
    LayoutEngineId, LayoutEngineRegistry, LayoutEngineRequest, LayoutError, LayoutNodePosition,
    LayoutOptions, LayoutRequest, LayoutResult, LayoutScope, LayoutSpacing,
    MIND_MAP_FREEFORM_LAYOUT_ENGINE_ID, MIND_MAP_RADIAL_LAYOUT_ENGINE_ID,
    layout_graph_to_transaction_with_engine, layout_graph_with_engine,
};
pub use family::{
    LAYERED_DAG_LAYOUT_FAMILY_ID, LayoutEngineCapability, LayoutEngineMetadata, LayoutFamilyId,
    LayoutFamilyMetadata, MIND_MAP_LAYOUT_FAMILY_ID,
};
pub use freeform::{
    MindMapFreeformLayoutEngine, layout_graph_to_transaction_with_mind_map_freeform,
    layout_graph_with_mind_map_freeform,
};
pub use mind_map::{
    MindMapRadialLayoutEngine, layout_graph_to_transaction_with_mind_map_radial,
    layout_graph_with_mind_map_radial,
};

/// Returns a registry containing Jellyflow's built-in layout engines.
pub fn builtin_layout_engine_registry() -> LayoutEngineRegistry {
    let mut registry = LayoutEngineRegistry::new();
    let inserted_layered_family = registry.insert_family(LayoutFamilyMetadata::layered_dag());
    debug_assert!(
        inserted_layered_family.is_ok(),
        "built-in layered DAG layout family should be unique"
    );
    let inserted_mind_map_family = registry.insert_family(LayoutFamilyMetadata::mind_map());
    debug_assert!(
        inserted_mind_map_family.is_ok(),
        "built-in mind-map layout family should be unique"
    );
    let inserted_dugong = registry.insert(DugongLayoutEngine);
    debug_assert!(
        inserted_dugong.is_ok(),
        "built-in dugong engine should be unique"
    );
    let inserted_dugong_metadata = registry.insert_metadata(LayoutEngineMetadata::dugong());
    debug_assert!(
        inserted_dugong_metadata.is_ok(),
        "built-in dugong metadata should be unique"
    );
    let inserted_mind_map = registry.insert(MindMapRadialLayoutEngine);
    debug_assert!(
        inserted_mind_map.is_ok(),
        "built-in mind-map engine should be unique"
    );
    let inserted_mind_map_metadata =
        registry.insert_metadata(LayoutEngineMetadata::mind_map_radial());
    debug_assert!(
        inserted_mind_map_metadata.is_ok(),
        "built-in radial mind-map metadata should be unique"
    );
    let inserted_freeform = registry.insert(MindMapFreeformLayoutEngine);
    debug_assert!(
        inserted_freeform.is_ok(),
        "built-in freeform engine should be unique"
    );
    let inserted_freeform_metadata =
        registry.insert_metadata(LayoutEngineMetadata::mind_map_freeform());
    debug_assert!(
        inserted_freeform_metadata.is_ok(),
        "built-in freeform mind-map metadata should be unique"
    );
    registry
}

#[cfg(test)]
mod tests;