ChartToPromela.h

Go to the documentation of this file.

#ifndef CHARTTOPROMELA_H_RP48RFDJ
#define CHARTTOPROMELA_H_RP48RFDJ

#include "Transformer.h"
#include "ChartToC.h"
#include "uscxml/util/DOM.h"

#include "promela/PromelaInlines.h"
#include "promela/PromelaCodeAnalyzer.h"

#include <ostream>

namespace uscxml {

class USCXML_API ChartToPromela : public ChartToC {
public:
    virtual ~ChartToPromela();
    static Transformer transform(const Interpreter& other);

    void writeTo(std::ostream& stream);

protected:
    ChartToPromela(const Interpreter& other) : ChartToC(other) {
        _prefix = "U" + _md5.substr(0, 8) + "_";
    }

    void writeTransitions(std::ostream& stream);
    void writeStates(std::ostream& stream);

    void writeCommonTypeDefs(std::ostream& stream);
    void writeCommonVariables(std::ostream& stream);
    void writeTypeDefs(std::ostream& stream);
    void writeVariables(std::ostream& stream);

//  void writeTypeDefs(std::ostream& stream);
//  void writeTypes(std::ostream& stream);
    void writeMacros(std::ostream& stream);
    void writeFSM(std::ostream& stream);
    void writeFSMDequeueEvent(std::ostream& stream);
//    void writeFSMRescheduleMachines(std::ostream& stream);
//    void writeFSMMacrostep(std::ostream& stream);
//    void writeFSMDequeueInternalOrSpontaneousEvent(std::ostream& stream);
    void writeFSMSelectTransitions(std::ostream& stream);
    void writeFSMRememberHistory(std::ostream& stream);
    void writeFSMEstablishEntrySet(std::ostream& stream);
    void writeFSMExitStates(std::ostream& stream);
    void writeFSMTakeTransitions(std::ostream& stream);
    void writeFSMEnterStates(std::ostream& stream);
    void writeFSMTerminateMachine(std::ostream& stream);

    void writeExecContent(std::ostream& stream, const XERCESC_NS::DOMNode* node, size_t indent = 0);
    void writeRaiseDoneDate(std::ostream& stream, const XERCESC_NS::DOMElement* donedata, size_t indent = 0);

    void writeStrings(std::ostream& stream);

    void writeCancelEvents(std::ostream& stream, size_t indent = 0);
    void writeScheduleMachines(std::ostream& stream, size_t indent = 0);
    void writeDetermineShortestDelay(std::ostream& stream, size_t indent = 0);
    void writeRescheduleProcess(std::ostream& stream, size_t indent = 0);
    void writeInsertWithDelay(std::ostream& stream, size_t indent = 0);
    void writeAdvanceTime(std::ostream& stream, size_t indent = 0);
    void writeRemovePendingEventsFromInvoker(std::ostream& stream, size_t indent = 0);

    void prepare();

    void writeBitClearMacro(std::ostream& stream);
    void writeBitHasAndMacro(std::ostream& stream);
    void writeBitHasAnyMacro(std::ostream& stream);
    void writeBitOrMacro(std::ostream& stream);
    void writeBitCopyMacro(std::ostream& stream);
    void writeBitAndMacro(std::ostream& stream);
    void writeBitAndNotMacro(std::ostream& stream);

    void printBitArray(std::ostream& stream,
                       const std::string& array,
                       size_t length,
                       size_t indent = 0);

    PromelaCodeAnalyzer* _analyzer = NULL;

    ChartToPromela* _parentTopMost = NULL;
    ChartToPromela* _parent = NULL;
    std::string _invokerid;

    size_t _internalQueueLength = 7;
    size_t _externalQueueLength = 7;
    bool _allowEventInterleaving = false;

    std::map<std::string, XERCESC_NS::DOMElement* > _machinesPerId;
    std::map<std::string, XERCESC_NS::DOMElement* >* _machinesAllPerId = NULL;
    std::map<XERCESC_NS::DOMElement*, ChartToPromela*> _machinesNested;
    std::map<XERCESC_NS::DOMElement*, ChartToPromela*>* _machinesAll = NULL;

    std::set<std::string> _dataModelVars;
    std::list<std::string> _varInitializers; // pending initializations for arrays

    std::string beautifyIndentation(const std::string& code, size_t indent = 0);
    void writeIfBlock(std::ostream& stream, std::list<XERCESC_NS::DOMElement*>& condChain, size_t indent = 0);

    std::string dataToAssignments(const std::string& prefix, const Data& data);
    std::string sanitizeCode(const std::string& code);
    std::string declForRange(const std::string& identifier, long minValue, long maxValue, bool nativeOnly = false);

    friend class PromelaCodeAnalyzer;
};

}

#endif /* end of include guard: CHARTTOPROMELA_H_RP48RFDJ */