/**
 *  @file
 *  @author     2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
 *  @copyright  Simplified BSD
 *
 *  @cond
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the FreeBSD license as published by the FreeBSD
 *  project.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 *  You should have received a copy of the FreeBSD license along with this
 *  program. If not, see <http://www.opensource.org/licenses/bsd-license>.
 *  @endcond
 */

#ifndef XPATHDATAMODEL_H_KN8TWG0V
#define XPATHDATAMODEL_H_KN8TWG0V

#include "uscxml/Interpreter.h"
#include <list>

#ifdef BUILD_AS_PLUGINS
#include "uscxml/plugins/Plugins.h"
#endif

namespace uscxml {
class Event;
class Data;
}

namespace uscxml {

class XPathFunctionIn : public Arabica::XPath::BooleanXPathFunction<std::string> {
public:
	XPathFunctionIn(int minArgs,
	                int maxArgs,
	                const std::vector<Arabica::XPath::XPathExpression<std::string> >& args,
	                InterpreterInfo* interpreter) :
		Arabica::XPath::BooleanXPathFunction<std::string>(minArgs, maxArgs, args),
		_interpreter(interpreter) {}

protected:
	bool doEvaluate(const Arabica::DOM::Node<std::string>& context,
	                const Arabica::XPath::ExecutionContext<std::string>& executionContext) const;
	InterpreterInfo* _interpreter;
};

class XPathFunctionResolver : public Arabica::XPath::FunctionResolver<std::string> {
public:
	virtual ~XPathFunctionResolver() { }

	virtual Arabica::XPath::XPathFunction<std::string>*
	resolveFunction(const std::string& namespace_uri,
	                const std::string& name,
	                const std::vector<Arabica::XPath::XPathExpression<std::string> >& argExprs) const;

	virtual std::vector<std::pair<std::string, std::string> > validNames() const;
	void setInterpreter(InterpreterInfo* interpreter) {
		_interpreter = interpreter;
	}
protected:
	Arabica::XPath::StandardXPathFunctionResolver<std::string> _xpathFuncRes;
	InterpreterInfo* _interpreter;
};

class NodeSetVariableResolver : public Arabica::XPath::VariableResolver<std::string> {
public:
	Arabica::XPath::XPathValue<std::string> resolveVariable(const std::string& namepaceUri,
	        const std::string& name) const;
	void setVariable(const std::string& name, const Arabica::XPath::NodeSet<std::string>& value);
	bool isDeclared(const std::string& name);

private:
	std::map<std::string, Arabica::XPath::NodeSet<std::string> > _variables;
	friend class XPathDataModel;
};

class XPathDataModel : public DataModelImpl {
public:
	XPathDataModel();
	virtual ~XPathDataModel();
	virtual boost::shared_ptr<DataModelImpl> create(InterpreterInfo* interpreter);

	virtual std::list<std::string> getNames() {
		std::list<std::string> names;
		names.push_back("xpath");
		return names;
	}

	virtual void initialize();
	virtual void setEvent(const Event& event);

	virtual bool validate(const std::string& location, const std::string& schema);
	virtual bool isLocation(const std::string& expr);

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

	virtual void pushContext();
	virtual void popContext();

	virtual void eval(const Arabica::DOM::Element<std::string>& scriptElem,
	                  const std::string& expr);
	virtual void assign(const Arabica::DOM::Element<std::string>& assignElem,
	                    const Arabica::DOM::Node<std::string>& node,
	                    const std::string& content);
	virtual void assign(const std::string& location, const Data& data);

	virtual void init(const Arabica::DOM::Element<std::string>& dataElem,
	                  const Arabica::DOM::Node<std::string>& node,
	                  const std::string& content);
	virtual void init(const std::string& location, const Data& data);

	virtual Data getStringAsData(const std::string& content);
	virtual bool isDeclared(const std::string& expr);

	virtual std::string evalAsString(const std::string& expr);
	virtual bool evalAsBool(const std::string& expr);
	virtual bool evalAsBool(const Arabica::DOM::Element<std::string>& node, const std::string& expr);
	virtual double evalAsNumber(const std::string& expr);

protected:
	Arabica::XPath::XPath<std::string> _xpath;
	Arabica::DOM::DOMImplementation<std::string> _domFactory;
	Arabica::DOM::Element<std::string> _datamodel;
	Arabica::DOM::Document<std::string> _doc;

	bool isValidIdentifier(const std::string& identifier);
	Arabica::XPath::NodeSet<std::string> dataToNodeSet(const Data& data);

	// resolve value to its type
	void assign(const Arabica::XPath::XPathValue<std::string>& key,
	            const Arabica::XPath::XPathValue<std::string>& value,
	            const Arabica::DOM::Element<std::string>& assignElem);
	void assign(const Arabica::XPath::XPathValue<std::string>& key,
	            const Arabica::XPath::NodeSet<std::string>& value,
	            const Arabica::DOM::Element<std::string>& assignElem);

	// assign value to a nodeset key
	void assign(const Arabica::XPath::NodeSet<std::string>& key,
	            const std::string& value,
	            const Arabica::DOM::Element<std::string>& assignElem);
	void assign(const Arabica::XPath::NodeSet<std::string>& key,
	            const double value,
	            const Arabica::DOM::Element<std::string>& assignElem);
	void assign(const Arabica::XPath::NodeSet<std::string>& key,
	            const bool value,
	            const Arabica::DOM::Element<std::string>& assignElem);
	void assign(const Arabica::XPath::NodeSet<std::string>& key,
	            const Arabica::XPath::NodeSet<std::string>& value,
	            const Arabica::DOM::Element<std::string>& assignElem);

	// assign value to an element key (from nodeset)
	void assign(const Arabica::DOM::Element<std::string>& key,
	            const Arabica::XPath::NodeSet<std::string>& value,
	            const Arabica::DOM::Element<std::string>& assignElem);


	// assign value to a text node key (from nodeset)
	void assign(const Arabica::DOM::Text<std::string>& key,
	            const Arabica::XPath::NodeSet<std::string>& value,
	            const Arabica::DOM::Element<std::string>& assignElem);


	NodeSetVariableResolver _varResolver;
	XPathFunctionResolver _funcResolver;

};

#ifdef BUILD_AS_PLUGINS
PLUMA_INHERIT_PROVIDER(XPathDataModel, DataModelImpl);
#endif

}

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