Interpreter.h

Go to the documentation of this file.

#ifndef INTERPRETER_H_6CD5A168
#define INTERPRETER_H_6CD5A168


#include "Common.h"

#include <map>
#include <string>
#include <vector>

#include "uscxml/interpreter/MicroStep.h"
#include "uscxml/interpreter/Logging.h"
#include "uscxml/plugins/DataModel.h"
#include "uscxml/plugins/Factory.h"
#include "uscxml/interpreter/ContentExecutor.h"
#include "uscxml/interpreter/EventQueue.h"
#include "uscxml/interpreter/InterpreterState.h"

#ifdef max
#error define NOMINMAX or undefine the max macro please (https://support.microsoft.com/en-us/kb/143208)
#endif

namespace uscxml {

class InterpreterMonitor;
class InterpreterImpl;
class InterpreterIssue;


class USCXML_API ActionLanguage {
public:
    Logger logger; 
    MicroStep microStepper; 
    DataModel dataModel; 
    ContentExecutor execContent; 
    EventQueue internalQueue; 
    EventQueue externalQueue; 
    DelayedEventQueue delayQueue; 
};

class USCXML_API Interpreter {
public:

    static Interpreter fromDocument(XERCESC_NS::DOMDocument* dom,
                                    const std::string& baseURL,
                                    bool copy = true);
    static Interpreter fromElement(XERCESC_NS::DOMElement* element,
                                   const std::string& baseURL);
    static Interpreter fromXML(const std::string& xml,
                               const std::string& baseURL);
    static Interpreter fromURL(const std::string& url);

    static Interpreter fromClone(const Interpreter& other);

    PIMPL_OPERATORS(Interpreter);

    InterpreterState step(size_t blockMs = std::numeric_limits<size_t>::max());

    void cancel();

    void reset();

    void deserialize(const std::string& encodedState);

    std::string serialize();

    std::list<XERCESC_NS::DOMElement*> getConfiguration();

    bool isInState(const std::string& stateId);

    InterpreterState getState();

    std::list<InterpreterIssue> validate();

    void receive(const Event& event);

    void setActionLanguage(ActionLanguage actionLanguage);

    ActionLanguage* getActionLanguage();

    void setFactory(Factory* factory);

    void addMonitor(InterpreterMonitor* monitor);

    void removeMonitor(InterpreterMonitor* monitor);

    Logger getLogger();

    std::shared_ptr<InterpreterImpl> getImpl() const {
        return _impl;
    }

protected:
    std::shared_ptr<InterpreterImpl> _impl;

};

}

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