Note: We deprecated the old version and refactored quite a few classes and interfaces.
Note: Some of the features described below may not yet have made it into the new version, but all will eventually. If implied functionality is not yet available just post an issue and we will make it a priority.
uSCXML is a platform to work with state-charts given as SCXML files. Currently, it consists of three principal components:
-
libuscxml: C++ library containing an interpreter and accompanying functionality. -
uscxml-browser: A standards compliant command-line interpreter of SCXML documents. -
uscxml-transform: A collection of transformation implementations to transpile SCXML, e.g. onto ANSI-C and VHDL.
There are no installers yet and we do not feature any releases. Just check for open issues and build from source. If you did download and build locally, you can create installers via make packages though.
Documentation is available at our github pages. It is created from inline comments in the source along with some dedicated markdown pages via doxygen. We try to keep it current and will update it ever again. For the most current documentation, you can run make docs in your build directory.
uSCXML itself is distributed under the Simplified BSD license as in, do not sue us and do not misrepresent authorship. There are currently four additional libraries that are required to compile uSCXML.
| Project | License | Comment |
|---|---|---|
| libcurl | MIT/X derivate | Used in uSCXML to fetch remote content |
| Xerces-C++ | Apache v2 | XML parser and DOM implementation |
| libevent | 3-clause BSD | Delayed event queues |
| uriparser | New BSD | Referring and resolving URIs |
At configure time, the uSCXML build-process will attempt to find and link several other libraries (e.g. Lua, v8) and additional licensing terms may apply.
For more detailled information, refer to the documentation.
uscxml::Interpreter scxml = uscxml::Interpreter::fromURL("...");
while(scxml.step() != uscxml::USCXML_FINISHED) {
...
}
# interpret state-chart from url
$ uscxml-browser https://raw.githubusercontent.com/tklab-tud/uscxml/master/test/w3c/null/test436.scxml
# transform given SCXML document into ANSI-C fragment
$ uscxml-transform -tc -i https://raw.githubusercontent.com/tklab-tud/uscxml/master/test/w3c/null/test436.scxml