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/plugins/DataModel.h"
#include "uscxml/interpreter/ContentExecutor.h"
#include "uscxml/interpreter/InterpreterState.h"

namespace uscxml {

class InterpreterMonitor;
class InterpreterImpl;
class InterpreterIssue;

class USCXML_API InterpreterOptions {
public:
    InterpreterOptions() :
        verbose(false),
        validate(false),
        withHTTP(true),
        withHTTPS(true),
        withWS(true),
        logLevel(0),
        httpPort(5080),
        httpsPort(5443),
        wsPort(5081) {
    }

    bool verbose;
    bool validate;
    bool withHTTP;
    bool withHTTPS;
    bool withWS;
    int logLevel;
    unsigned short httpPort;
    unsigned short httpsPort;
    unsigned short wsPort;
    std::string pluginPath;
    std::string certificate;
    std::string privateKey;
    std::string publicKey;
    std::vector<std::pair<std::string, InterpreterOptions*> > interpreters;
    std::map<std::string, std::string> additionalParameters;

    std::string error;

    operator bool() {
        return error.length() == 0;
    }

    static void printUsageAndExit(const char* progName);
    static InterpreterOptions fromCmdLine(int argc, char** argv);

};

class USCXML_API ActionLanguage {
public:
    MicroStep microStepper; 
    DataModel dataModel; 
    ContentExecutor execContent; 
};

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(bool blocking = false);

    void cancel();

    void reset();

    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);
    
    void setMonitor(InterpreterMonitor* monitor);

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

protected:
    std::shared_ptr<InterpreterImpl> _impl;

};

}

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