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
|
/**
* @file
* @author 2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
* @copyright Simplified BSD
*
* @cond
* This program is free software: you can redistribute it and/or modify
* it under the terms of the FreeBSD license as published by the FreeBSD
* project.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the FreeBSD license along with this
* program. If not, see <http://www.opensource.org/licenses/bsd-license>.
* @endcond
*/
#ifndef SCXMLDOTWRITER_H_AOP0OHXX
#define SCXMLDOTWRITER_H_AOP0OHXX
#include "uscxml/Interpreter.h"
#include <DOM/Document.hpp>
#include <XPath/XPath.hpp>
#include <fstream>
#include <set>
#undef max
#include <limits>
namespace uscxml {
class Interpreter;
/**
* This writer, added as a monitor will output .dot files.
*
* # create a set of pdfs form the dot files
* $ dot -Tpdf -O *.dot
* or
* $ find . -name "*.dot" -exec dot -Tpdf -O {} \;
*
* # create a movie from the pdfs
* $ dot -Tgif -O *.dot
* or
* $ find . -name "*.dot" -exec dot -Tgif -O {} \;
*
* $ ffmpeg -r 3 -i <NAME>.%06d.dot.gif -r 25 movie.mpg
* $ convert -delay 20 *.gif animated.gif
*
* # unflatten can be used to create more compact graphs
* find . -name "*.dot" -exec unflatten -f -l2 -o {}.flat.dot {} \;
*/
class USCXML_API SCXMLDotWriter : public InterpreterMonitor {
public:
enum PortType {
PORT_TARGET,
PORT_EVENT,
PORT_TRANSITION
};
struct StateAnchor {
StateAnchor() : childDepth(std::numeric_limits<int32_t>::max()), transDepth(std::numeric_limits<int32_t>::max()), type(PORT_TARGET) {}
Arabica::DOM::Element<std::string> element;
int32_t childDepth;
int32_t transDepth;
PortType type;
operator bool() const {
return childDepth != -1 || transDepth != -1 || element;
}
};
struct ElemDetails {
std::string name;
std::string details;
std::string content;
};
struct DotState {
DotState() : isBorder(false), portType(PORT_TARGET) {}
Arabica::DOM::Element<std::string> node;
Arabica::XPath::NodeSet<std::string> transitions;
std::multimap<std::string, Arabica::DOM::Element<std::string> > targets; // key is remote node, transition is element
std::multimap<std::string, Arabica::DOM::Element<std::string> > events; // key is event name, value is transitions that react
bool isBorder;
PortType portType;
std::set<std::string> childs;
std::set<std::string> initialchilds;
typedef std::multimap<std::string, Arabica::DOM::Element<std::string> > mmap_s_e_t;
};
enum EdgeType {
EDGE_INITAL,
EDGE_TRANSIION,
EDGE_SPONTANEOUS
};
struct DotEdge {
DotEdge() : type(EDGE_TRANSIION) {}
DotEdge(const std::string& from, const std::string& to) : type(EDGE_TRANSIION), from(from), to(to) {
}
bool operator< (const DotEdge& other) const {
return from + fromPort + to + toPort > other.from + other.fromPort + other.to + other.toPort;
}
EdgeType type;
std::string from;
std::string fromCompass;
std::string fromPort;
std::string to;
std::string toPort;
std::string toCompass;
};
SCXMLDotWriter();
~SCXMLDotWriter();
virtual void onStableConfiguration(Interpreter interpreter);
virtual void afterCompletion(Interpreter interpreter);
virtual void beforeTakingTransition(Interpreter interpreter, const Arabica::DOM::Element<std::string>& transition, bool moreComing);
virtual void beforeMicroStep(Interpreter interpreter);
static std::string htmlLabelForId(const std::string& stateId, int minRows = 0);
static void toDot(const std::string& filename,
Interpreter interpreter,
const Arabica::DOM::Element<std::string>& transition = Arabica::DOM::Element<std::string>()) {
std::list<SCXMLDotWriter::StateAnchor> emptyAnchors = std::list<SCXMLDotWriter::StateAnchor>();
toDot(filename, interpreter, emptyAnchors, transition);
}
static void toDot(const std::string& filename,
Interpreter interpreter,
const std::list<SCXMLDotWriter::StateAnchor>& stateAnchors,
const Arabica::DOM::Element<std::string>& transition = Arabica::DOM::Element<std::string>());
void writeTo(std::ostream& os);
std::string getDetailedLabel(const Arabica::DOM::Element<std::string>& elem, int indentation = 0);
std::string colorForIndent(int indent);
std::string idForNode(const Arabica::DOM::Node<std::string>& node);
std::string nameForNode(const Arabica::DOM::Node<std::string>& node);
std::string getPrefix();
static std::string dotEscape(const std::string& text);
static std::string portEscape(const std::string& text);
protected:
SCXMLDotWriter(Interpreter interpreter,
const std::list<SCXMLDotWriter::StateAnchor>& stateAnchors,
const Arabica::DOM::Element<std::string>& transition);
void assembleGraph(const Arabica::DOM::Element<std::string>& start,
int32_t childDepth = std::numeric_limits<int32_t>::max(),
int32_t transDepth = std::numeric_limits<int32_t>::max());
void writeStateElement(std::ostream& os, const Arabica::DOM::Element<std::string>& state);
void writePerTransitionPorts(std::ostream& os, const DotState& dotState, int stateLines = 0);
void writePerEventPorts(std::ostream& os, const DotState& dotState, int stateLines = 0);
void writePerTargetPorts(std::ostream& os, const DotState& dotState, int stateLines = 0);
void writeUnknownNode(std::ostream& os, const std::string& targetId);
int _iteration;
std::set<std::string> _knownIds;
std::set<std::string> _unknownNodes;
int _indentation;
std::map<std::string, DotState> _graph;
std::set<DotEdge> _edges;
// these are only set in ephemeral instances per monitor call
Arabica::DOM::Element<std::string> _transition;
Arabica::DOM::Element<std::string> _scxml;
Interpreter _interpreter;
bool _isFlat;
std::string _xmlNSPrefix;
std::list<StateAnchor> _anchors;
std::map<std::string, DotEdge> _histories;
PortType _portType;
};
}
#endif /* end of include guard: SCXMLDOTWRITER_H_AOP0OHXX */
|
