DataModelImpl.h

Go to the documentation of this file.

#ifndef DATAMODELIMPL_H_5A33C087
#define DATAMODELIMPL_H_5A33C087

#include "uscxml/config.h"
#include "uscxml/Common.h"
#include "uscxml/plugins/Invoker.h"
#include "uscxml/plugins/IOProcessor.h"

#include <xercesc/dom/DOM.hpp>

#include <list>
#include <string>
#include <memory>

namespace uscxml {

class InterpreterImpl;
class DataModelImpl;

class USCXML_API DataModelCallbacks {
public:
    virtual const std::string& getName() = 0;
    virtual const std::string& getSessionId() = 0;
    virtual const std::map<std::string, IOProcessor>& getIOProcessors() = 0;
    virtual bool isInState(const std::string& stateId) = 0;
    virtual XERCESC_NS::DOMDocument* getDocument() const = 0;
    virtual const std::map<std::string, Invoker>& getInvokers() = 0;
};

class USCXML_API DataModelExtension {
public:
    DataModelExtension() : dm(NULL) {}
    virtual ~DataModelExtension() {}
    virtual std::string provides() = 0;
    virtual Data getValueOf(const std::string& member) = 0;
    virtual void setValueOf(const std::string& member, const Data& data) = 0;
    DataModelImpl* dm;
};

class USCXML_API DataModelImpl {
public:
    virtual ~DataModelImpl() {}
    
    virtual std::shared_ptr<DataModelImpl> create(DataModelCallbacks* callbacks) = 0;

    virtual std::list<std::string> getNames() = 0;

    virtual bool isValidSyntax(const std::string& expr) {
        return true; // overwrite when datamodel supports it
    }
    
    virtual void setEvent(const Event& event) = 0;

    size_t replaceExpressions(std::string& content);


    // foreach
    virtual uint32_t getLength(const std::string& expr) = 0;
    virtual void setForeach(const std::string& item,
                            const std::string& array,
                            const std::string& index,
                            uint32_t iteration) = 0;

    virtual Data getAsData(const std::string& content) = 0;

    virtual Data evalAsData(const std::string& content) = 0;
    
    virtual bool evalAsBool(const std::string& expr) = 0;

    virtual bool isDeclared(const std::string& expr) = 0;

    virtual void assign(const std::string& location, const Data& data) = 0;
    
    virtual void init(const std::string& location, const Data& data) = 0;


    virtual void addExtension(DataModelExtension* ext);
    virtual std::string andExpressions(std::list<std::string>) {
        return "";
    }

protected:
    DataModelCallbacks* _callbacks;
};

}

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