/*
 * Copyright (c) 2010 Remko Tronçon
 * Licensed under the GNU General Public License v3.
 * See Documentation/Licenses/GPLv3.txt for more information.
 */

#pragma once

#include <boost/shared_ptr.hpp>
#include "Swiften/Parser/AttributeMap.h"

#include "Swiften/Elements/Payload.h"

namespace Swift {
	class String;

	/**
	 * A parser for XMPP stanza payloads.
	 *
	 * The parser is event driven: handleStartElement, handleEndElement, and handleCharacterData will be called
	 * when the parser detects start and end of XML elements, or character data.
	 * After the data for the given top-level element is processed, getPayload() will be called to retrieve the
	 * payload.
	 */
	class PayloadParser {
		public:
			virtual ~PayloadParser();

			/**
			 * Handle the start of an XML element.
			 */
			virtual void handleStartElement(const String& element, const String& ns, const AttributeMap& attributes) = 0;

			/**
			 * Handle the end of an XML element.
			 */
			virtual void handleEndElement(const String& element, const String& ns) = 0;

			/**
			 * Handle character data.
			 */
			virtual void handleCharacterData(const String& data) = 0;

			/**
			 * Retrieve a pointer to the payload.
			 */
			virtual Payload::ref getPayload() const = 0;
	};
}