//------------------------------------------------------------------------------
// <copyright file="LqrSMACXmlCmdOutputFormatter.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
// </summary>
//
// <owner></owner>
//------------------------------------------------------------------------------

#ifndef __LqrSMACXmlCmdOutputFormatter_h__
#define __LqrSMACXmlCmdOutputFormatter_h__

#include "LqrSMACSharedLib.h"
#include "LqrSMACCmdOutputFormatter.h"
#include "LqrSMACXmlDOM.h"
#include <list>
#include <string>
#include <sstream>
#include <map>

namespace LiquidRobotics {
namespace SMACFramework {

class SHARED_LIB_PUBLIC XmlCmdOutputFormatter : public CmdOutputFormatter
{
public:

	typedef CmdOutputFormatter Base;
	typedef std::string string;

	XmlCmdOutputFormatter(const string& _options);
	virtual ~XmlCmdOutputFormatter();

	virtual void AddAttribute(const string& attributeName, const string& attributeValue);
	virtual void AppendOutput(const void* pStart, unsigned len);
	virtual void AppendResult(const void* pStart, unsigned len);
	virtual void AppendTag(const string& tagName, const void* pStart, unsigned len);
	virtual string GetAttribute(const string& attributeName) const;
	virtual string GetOutput() const;
	virtual string GetTag(const string& tagName) const;
	virtual Ptr NewChild();
	virtual OutputStream& ToStream(OutputStream& stm, unsigned nesting = 0, unsigned maxLength = ~0) const;

private:

	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNode XmlNode;

	template<typename T>
	void SetValueTag(T& node, const string& tagName, const string& content) const;
	string EncodeField(const string& fieldContent, string& encodingType) const;
	static bool RequiresBinaryEncoding(const string& fieldContent);
	void WriteNode(XmlNode& node, unsigned nesting, unsigned maxLength) const;

	typedef std::stringstream stringstream;
	typedef boost::shared_ptr<stringstream> streamstreamptr;

	typedef std::list<string> StringList;
	typedef std::map<string,string> StringStringMap;
	typedef std::map<string,streamstreamptr> StringStreamMap;

	Mutex collectionsMutex;
	const string& options;
	StringStringMap attributes;
	StringList results;
	StringStreamMap tags;
};

}
}

#endif
