MicroStepImpl.h

Go to the documentation of this file.

#ifndef MICROSTEPIMPL_H_98233709
#define MICROSTEPIMPL_H_98233709

#include <list>
#include <set>
#include <string>

#include "uscxml/Common.h"
#include "uscxml/Interpreter.h"
#include "uscxml/messages/Event.h"


namespace uscxml {

class InterpreterMonitor;

class USCXML_API MicroStepCallbacks {
public:
    virtual Event dequeueInternal() = 0;
    virtual Event dequeueExternal(size_t blockMs) = 0;
    virtual bool isMatched(const Event& event, const std::string& eventDesc) = 0;
    virtual void raiseDoneEvent(XERCESC_NS::DOMElement* state, XERCESC_NS::DOMElement* doneData) = 0;

    virtual bool isTrue(const std::string& expr) = 0;
    virtual void initData(XERCESC_NS::DOMElement* element) = 0;

    virtual void process(XERCESC_NS::DOMElement* block) = 0;

    virtual void invoke(XERCESC_NS::DOMElement* invoke) = 0;
    virtual void uninvoke(XERCESC_NS::DOMElement* invoke) = 0;

    virtual std::set<InterpreterMonitor*> getMonitors() = 0;
    virtual Interpreter getInterpreter() = 0;
    virtual Logger getLogger() = 0;

    virtual Data& getCache() = 0;

};

class USCXML_API MicroStepImpl {
public:
    enum Binding {
        EARLY = 0,
        LATE = 1
    };

    MicroStepImpl(MicroStepCallbacks* callbacks) : _callbacks(callbacks) {}
    virtual std::shared_ptr<MicroStepImpl> create(MicroStepCallbacks* callbacks) = 0;

    virtual InterpreterState step(size_t blockMs) = 0;
    virtual void reset() = 0; 
    virtual bool isInState(const std::string& stateId) = 0;
    virtual std::list<XERCESC_NS::DOMElement*> getConfiguration() = 0;

    virtual void init(XERCESC_NS::DOMElement* scxml) = 0;
    virtual void markAsCancelled() = 0;

    virtual void deserialize(const Data& encodedState) = 0;
    virtual Data serialize() = 0;

protected:
    MicroStepCallbacks* _callbacks;

};

}

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