bpmncheck 0.3.0

A library to sanity-check Business Process Model Notation models
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

/*
Copyright 2025 Erwan Mahe (github.com/erwanM974)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/


use graphviz_dot_builder::{edge::{edge::GraphVizEdge}, graph::graph::GraphVizDiGraph, item::{cluster::GraphVizCluster, node::{node::GraphVizNode, style::{GraphvizNodeStyleItem, GvNodeShape}}}, traits::DotBuildable};

use crate::model::{activity::ActivityType, diagram::{Diagram, ProcessContentRef}, event::EventType, gateway::GatewayType, id::BpmnId};




pub fn bpmn_subproc_repr(
    bpmn : &Diagram,
    proc_id : &BpmnId,
    proc_content : &ProcessContentRef
) -> GraphVizCluster {
    let mut cluster = GraphVizCluster::new(
        proc_id.id.clone(), 
        vec![], 
        vec![], 
        vec![]
    );
    for evt_id in &proc_content.direct_child_events {
        let evt = bpmn.events.get(evt_id).unwrap();
        let mut style = vec![
            GraphvizNodeStyleItem::Label("".to_string())
            ];
        match &evt.event_type {
            EventType::Boundary(_) => {
                style.push(GraphvizNodeStyleItem::Shape(GvNodeShape::Hexagon));
            },
            EventType::End => {
                style.push(GraphvizNodeStyleItem::Shape(GvNodeShape::Circle));
                style.push(GraphvizNodeStyleItem::PenWidth(10));
            },
            EventType::IntermediateCatch => {
                style.push(GraphvizNodeStyleItem::Shape(GvNodeShape::DoubleCircle));
            },
            EventType::IntermediateThrow => {
                style.push(GraphvizNodeStyleItem::Shape(GvNodeShape::DoubleCircle));
            },
            EventType::Start => {
                style.push(GraphvizNodeStyleItem::Shape(GvNodeShape::Circle));
            },
        }
        let node = GraphVizNode::new(
            evt_id.id.clone(), 
            style
        );
        cluster.add_node(node);
    }
    for act_id in &proc_content.direct_child_activities {
        let act = bpmn.activities.get(act_id).unwrap();
        match &act.activity_type {
            ActivityType::SubProcess(sub_proc_content) => {
                let sub_cluster = bpmn_subproc_repr(bpmn,act_id,sub_proc_content);
                cluster.add_cluster(sub_cluster);
            },
            _ => {
                let mut style = vec![GraphvizNodeStyleItem::Shape(GvNodeShape::Rectangle)];
                if let Some(name) = &act.name {
                    style.push(GraphvizNodeStyleItem::Label(name.clone()));
                }
                let node = GraphVizNode::new(
                    act_id.id.clone(), 
                    style
                    );
                cluster.add_node(node);
            }
        }
    }
    for gt_id in &proc_content.direct_child_gateways {
        let gate = bpmn.gateways.get(gt_id).unwrap();
        let mut style = vec![GraphvizNodeStyleItem::Shape(GvNodeShape::Diamond)];
        match gate.gateway_type {
            GatewayType::Exclusive => {
                style.push(GraphvizNodeStyleItem::Label("X".to_string()));
            },
            GatewayType::Inclusive => {
                style.push(GraphvizNodeStyleItem::Label("O".to_string()));
            },
            GatewayType::Parallel => {
                style.push(GraphvizNodeStyleItem::Label("+".to_string()));
            }
        }
        let node = GraphVizNode::new(
            gt_id.id.clone(), 
            style
            );
        cluster.add_node(node);
    }
    cluster
}


pub fn bpmn_repr(
    bpmn : &Diagram
) -> GraphVizDiGraph {
    // Create a new graph:
    let mut digraph = GraphVizDiGraph::new(vec![]);
    // processes
    for (process_id,process) in &bpmn.top_level_processes {
        let cluster = bpmn_subproc_repr(bpmn,process_id,&process.content);
        digraph.add_cluster(cluster);
    }
    // edges
    for flow in bpmn.sequence_flows.values() {
        let edge = GraphVizEdge::new(
            flow.source_ref.id.clone(),
            None,
            flow.target_ref.id.clone(),
            None,
            vec![]
        );
        digraph.add_edge(edge);
    }
    for flow in bpmn.message_flows.values() {
        let edge = GraphVizEdge::new(
            flow.source_ref.id.clone(),
            None,
            flow.target_ref.id.clone(),
            None,
            vec![]
        );
        digraph.add_edge(edge);
    }
    digraph
}