diff options
Diffstat (limited to 'src/uscxml/transform/ChartToPromela.h')
-rw-r--r-- | src/uscxml/transform/ChartToPromela.h | 279 |
1 files changed, 279 insertions, 0 deletions
diff --git a/src/uscxml/transform/ChartToPromela.h b/src/uscxml/transform/ChartToPromela.h new file mode 100644 index 0000000..75e3339 --- /dev/null +++ b/src/uscxml/transform/ChartToPromela.h @@ -0,0 +1,279 @@ +/** + * @file + * @author 2012-2014 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 CHARTTOPROMELA_H_RP48RFDJ +#define CHARTTOPROMELA_H_RP48RFDJ + +#include "Transformer.h" +#include "ChartToFSM.h" +#include "uscxml/interpreter/InterpreterDraft6.h" +#include "uscxml/DOMUtils.h" +#include "uscxml/util/Trie.h" + +#include <DOM/Document.hpp> +#include <DOM/Node.hpp> +#include <XPath/XPath.hpp> +#include <ostream> + +namespace uscxml { + +class USCXML_API PromelaInline { +public: + PromelaInline() : type(PROMELA_NIL) {} + + operator bool() { + return (type != PROMELA_NIL); + } + + void dump(); + + enum PromelaInlineType { + PROMELA_NIL, + PROMELA_CODE, + PROMELA_EVENT_SOURCE, + PROMELA_EVENT_SOURCE_CUSTOM, + PROMELA_PROGRESS_LABEL, + PROMELA_ACCEPT_LABEL, + PROMELA_END_LABEL + }; + + std::string content; + std::list<std::list<std::string> > sequences; + + PromelaInlineType type; +}; + +class USCXML_API PromelaInlines { +public: + PromelaInlines() : progressLabels(0), acceptLabels(0), endLabels(0), eventSources(0), customEventSources(0), codes(0) {} + + void merge(const PromelaInlines& other) { + inlines.insert(inlines.end(), other.inlines.begin(), other.inlines.end()); + progressLabels += other.progressLabels; + acceptLabels += other.acceptLabels; + endLabels += other.endLabels; + eventSources += other.eventSources; + customEventSources += other.customEventSources; + codes += other.codes; + } + + operator bool() { + return inlines.size() > 0; + } + + std::list<PromelaInline> inlines; + int progressLabels; + int acceptLabels; + int endLabels; + int eventSources; + int customEventSources; + int codes; +}; + +class USCXML_API PromelaCodeAnalyzer { +public: + class PromelaTypedef { + public: + PromelaTypedef() : arraySize(0), minValue(0), maxValue(0) {} + std::string name; + std::string type; + size_t arraySize; + size_t minValue; + size_t maxValue; + std::map<std::string, PromelaTypedef> types; + + bool operator==(const PromelaTypedef& other) const { + return name == other.name; + } + + }; + + PromelaCodeAnalyzer() : _eventTrie("."), _lastStrIndex(1), _lastStateIndex(0), _lastEventIndex(1), _usesInPredicate(false), _usesPlatformVars(false) { + } + + void addCode(const std::string& code); + void addEvent(const std::string& eventName); + void addState(const std::string& stateName); + void addOrigState(const std::string& stateName); + void addLiteral(const std::string& stateName, int forceIndex = -1); + + bool usesComplexEventStruct() { + return _typeDefs.types.find("_event") != _typeDefs.types.end() && _typeDefs.types["_event"].types.size() > 0; + } + bool usesEventField(const std::string& fieldName) { + if (usesComplexEventStruct() && _typeDefs.types["_event"].types.find(fieldName) != _typeDefs.types["_event"].types.end()) + return true; + return false; + } + + bool usesInPredicate() { + return _usesInPredicate; + } + bool usesPlatformVars() { + return _usesPlatformVars; + } + + std::string macroForLiteral(const std::string& literal); + int indexForLiteral(const std::string& literal); + + std::set<std::string> getLiterals() { + return _strLiterals; + } + std::set<std::string> getEventsWithPrefix(const std::string& prefix); + std::map<std::string, int>& getEvents() { + return _events; + } + + std::map<std::string, int>& getStates() { + return _states; + } + + std::map<std::string, int>& getOrigStates() { + return _origStateIndex; + } + + + Trie& getTrie() { + return _eventTrie; + } + + std::string replaceLiterals(const std::string code); + + PromelaTypedef& getTypes() { + return _typeDefs; + } + +protected: + std::string createMacroName(const std::string& literal); + int enumerateLiteral(const std::string& literal, int forceIndex = -1); + + std::set<std::string> _strLiterals; // all string literals + std::map<std::string, std::string> _strMacroNames; // macronames for string literals + std::map<std::string, int> _strIndex; // integer enumeration for string + std::map<std::string, int> _origStateIndex; // state enumeration for original states + + std::map<std::string, int> _states; + std::map<std::string, int> _events; + + PromelaTypedef _typeDefs; + + Trie _eventTrie; + +private: + std::set<std::string> _macroNameSet; // helper set for uniqueness of macros + int _lastStrIndex; + int _lastStateIndex; + int _lastEventIndex; + bool _usesInPredicate; + bool _usesPlatformVars; +}; + +class USCXML_API PromelaEventSource { +public: + + enum PromelaEventSourceType { + PROMELA_EVENT_SOURCE_INVALID, + PROMELA_EVENT_SOURCE_INVOKER, + PROMELA_EVENT_SOURCE_GLOBAL, + }; + + PromelaEventSource(); + PromelaEventSource(const PromelaInlines& sources, const Arabica::DOM::Node<std::string>& parent); + + void writeStartEventSources(std::ostream& stream, int indent = 0); + void writeStopEventSources(std::ostream& stream, int indent = 0); + void writeDeclarations(std::ostream& stream, int indent = 0); + void writeEventSource(std::ostream& stream); + + operator bool() { + return type != PROMELA_EVENT_SOURCE_INVALID; + } + + std::string name; + PromelaInlines eventSources; + Arabica::DOM::Node<std::string> container; + PromelaEventSourceType type; + PromelaCodeAnalyzer* analyzer; +}; + +class USCXML_API ChartToPromela : public TransformerImpl, public ChartToFSM { +public: + + virtual ~ChartToPromela() {} + static Transformer transform(const Interpreter& other); + + void writeTo(std::ostream& stream); + +protected: + ChartToPromela(const Interpreter& other) : TransformerImpl(), ChartToFSM(other) {} + + void initNodes(); + + static std::string beautifyIndentation(const std::string& code, int indent = 0); + + void writeProgram(std::ostream& stream); + + void writeEvents(std::ostream& stream); + void writeStates(std::ostream& stream); + void writeStateMap(std::ostream& stream); + void writeTypeDefs(std::ostream& stream); + void writeStrings(std::ostream& stream); + void writeDeclarations(std::ostream& stream); + void writeEventSources(std::ostream& stream); + void writeTransition(std::ostream& stream, const GlobalTransition* transition, int indent = 0); + void writeExecutableContent(std::ostream& stream, const Arabica::DOM::Node<std::string>& node, int indent = 0); + void writeInlineComment(std::ostream& stream, const Arabica::DOM::Node<std::string>& node); + void writeFSM(std::ostream& stream); + void writeEventDispatching(std::ostream& stream); + void writeMain(std::ostream& stream); + + void writeIfBlock(std::ostream& stream, const Arabica::XPath::NodeSet<std::string>& condChain, int indent = 0); + void writeDispatchingBlock(std::ostream& stream, std::list<GlobalTransition*>, int indent = 0); + + Arabica::XPath::NodeSet<std::string> getTransientContent(const Arabica::DOM::Element<std::string>& state, const std::string& source = ""); + //Arabica::DOM::Node<std::string> getUltimateTarget(const Arabica::DOM::Element<std::string>& transition); + + static PromelaInlines getInlinePromela(const std::string&); + static PromelaInlines getInlinePromela(const Arabica::XPath::NodeSet<std::string>& elements, bool recurse = false); + static PromelaInlines getInlinePromela(const Arabica::DOM::Node<std::string>& elements); + + static std::string declForRange(const std::string& identifier, long minValue, long maxValue, bool nativeOnly = false); + +// std::string replaceStringsInExpression(const std::string& expr); + + std::string sanitizeCode(const std::string& code); + +// Arabica::XPath::NodeSet<std::string> _globalStates; +// Arabica::DOM::Node<std::string> _startState; +// std::map<std::string, Arabica::DOM::Element<std::string> > _states; +// std::map<Arabica::DOM::Element<std::string>, int> _transitions; + + std::list<std::string> _varInitializers; // pending initializations for arrays + + PromelaCodeAnalyzer _analyzer; + + std::map<std::string, PromelaEventSource> _invokers; + PromelaEventSource _globalEventSource; + + friend class PromelaEventSource; +}; + +} + +#endif /* end of include guard: CHARTTOPROMELA_H_RP48RFDJ */ |