/** 
 * @file lltemplatemessagereader.h
 * @brief Declaration of LLTemplateMessageReader class.
 *
 * $LicenseInfo:firstyear=2007&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library 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.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLTEMPLATEMESSAGEREADER_H
#define LL_LLTEMPLATEMESSAGEREADER_H

#include "llmessagereader.h"

class LLMessageTemplate;
class LLMsgData;

class LLTemplateMessageReader : public LLMessageReader
{
public:

	typedef std::map<U32, LLMessageTemplate*> message_template_number_map_t;

	LLTemplateMessageReader(message_template_number_map_t&);
    ~LLTemplateMessageReader() override;

	/** All get* methods expect pointers to canonical strings. */
	void getBinaryData(const char *blockname, const char *varname, 
							   void *datap, S32 size, S32 blocknum = 0, 
							   S32 max_size = S32_MAX) override;
	void getBOOL(const char *block, const char *var, BOOL &data, 
						 S32 blocknum = 0) override;
	void getS8(const char *block, const char *var, S8 &data, 
					   S32 blocknum = 0) override;
	void getU8(const char *block, const char *var, U8 &data, 
					   S32 blocknum = 0) override;
	void getS16(const char *block, const char *var, S16 &data, 
						S32 blocknum = 0) override;
	void getU16(const char *block, const char *var, U16 &data, 
						S32 blocknum = 0) override;
	void getS32(const char *block, const char *var, S32 &data, 
						S32 blocknum = 0) override;
	void getF32(const char *block, const char *var, F32 &data, 
						S32 blocknum = 0) override;
	void getU32(const char *block, const char *var, U32 &data, 
						S32 blocknum = 0) override;
	void getU64(const char *block, const char *var, U64 &data, 
						S32 blocknum = 0) override;
	void getF64(const char *block, const char *var, F64 &data, 
						S32 blocknum = 0) override;
	void getVector3(const char *block, const char *var, 
							LLVector3 &vec, S32 blocknum = 0) override;
	void getVector4(const char *block, const char *var, 
							LLVector4 &vec, S32 blocknum = 0) override;
	void getVector3d(const char *block, const char *var, 
							 LLVector3d &vec, S32 blocknum = 0) override;
	void getQuat(const char *block, const char *var, LLQuaternion &q, 
						 S32 blocknum = 0) override;
	void getUUID(const char *block, const char *var, LLUUID &uuid, 
						 S32 blocknum = 0) override;
	void getIPAddr(const char *block, const char *var, U32 &ip, 
						   S32 blocknum = 0) override;
	void getIPPort(const char *block, const char *var, U16 &port, 
						   S32 blocknum = 0) override;
	void getString(const char *block, const char *var, 
						   S32 buffer_size, char *buffer, S32 blocknum = 0) override;
	void getString(const char *block, const char *var,  std::string& outstr,
						   S32 blocknum = 0) override;

	S32	getNumberOfBlocks(const char *blockname) override;
	S32	getSize(const char *blockname, const char *varname) override;
	S32	getSize(const char *blockname, S32 blocknum, 
						const char *varname) override;

	void clearMessage() override;

	const char* getMessageName() const override;
	S32 getMessageSize() const override;

	void copyToBuilder(LLMessageBuilder&) const override;

	BOOL validateMessage(const U8* buffer, S32 buffer_size, 
						 const LLHost& sender, bool trusted = false, bool custom = false);
	BOOL readMessage(const U8* buffer, const LLHost& sender);

	bool isTrusted() const;
	bool isBanned(bool trusted_source) const;
	bool isUdpBanned() const;

	BOOL               decodeData(const U8* buffer, const LLHost& sender, bool custom = false);
	LLMessageTemplate* getTemplate();

private:

	void getData(const char *blockname, const char *varname, void *datap, 
				 S32 size = 0, S32 blocknum = 0, S32 max_size = S32_MAX);

	BOOL decodeTemplate(const U8* buffer, S32 buffer_size,  // inputs
						LLMessageTemplate** msg_template, bool custom = false);	// outputs

	void logRanOffEndOfPacket( const LLHost& host, const S32 where, const S32 wanted );

	S32	mReceiveSize;
	LLMessageTemplate* mCurrentRMessageTemplate;
	LLMsgData* mCurrentRMessageData;
	message_template_number_map_t& mMessageNumbers;
};

#endif // LL_LLTEMPLATEMESSAGEREADER_H
